Code contributions

We appreciate you taking the initiative to contribute to the Learn WordPress codebase.

Please take a moment to read these guidelines in depth. Following the guidelines helps to communicate that you respect the time of the other contributors to the project. In turn, they’ll do their best to reciprocate that respect when working with you, across time zones and around the world.

Should you have any questions about contributing, please join the #training channel in the Slack.

Reporting a bug

Think you’ve found a bug? We’d love for you to help us get it fixed.

Before you create a new issue, you should search existing issues to see if there’s an existing resolution to it, or if it’s already been fixed.

Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, use the Bug Report template and create a GitHubGitHub GitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. issue to make sure it gets addressed.

Top ↑

Fixing a bug

If you find an issue you’d like to work on, please go ahead and fork the repository to create your patch. You’re welcome to comment on an issue and ask to have it assigned to you.

If you’re looking for something to work on, please take a look at this list of open issues.

Top ↑

Creating a pull request

Please first open an ideas issue to suggest new commands, or open an issue in the appropriate repository to suggest enhancements to existing commands. Opening an issue before submitting a pull request helps us provide architectural and implementation guidance before you spend too much time on the code.

Once you’ve decided to commit the time to see your pull request through, please fork the Learn WordPress repository to your GitHub account, and clone that repository locally to work on. Follow the readme instructions to get the local development environment set up.

The Learn WordPress-specific coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. functionality exists in the wporg-learn pluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the Plugin Directory or can be cost-based plugin from a third-party, and any theme-related functionality is in the wporg-learn-2020 theme. When you are ready, create a branch that includes your suggested updates, and create the pull request from that branch.

While we don’t require specific naming conventions for branches, it is helpful if you name it using the format {type}/{issueid-name}. For example, /bugfix/874-fix-tutorial-padding or /feature/875-add-language-filtering.

If there are any testing steps that are needed to review your pull request, please include them in the description. Please also include any relevant issue labels in the pull request.

Take a look at this pull request for a good example.

Last updated: