Contributing Edit

Welcome and thanks!

We appreciate you taking the initiative to contribute to WP-CLI. It’s because of you, and the community around you, that WP-CLI is such a great project.

Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.

Please take a moment to read these guidelines at 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 timezones and around the world.

Reporting a bug 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 in a newer version of WP-CLI. You should also check our documentation on common issues and their fixes.

Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please follow our guidelines for submitting a bug report to make sure it gets addressed in a timely manner.

Top ↑

Creating a pull request Creating a pull request

Want to contribute a new feature? WP-CLI is a mature project, and already chock-full of useful functionality. Please first open a new issue to discuss whether the feature is a good fit for WP-CLI core, or might be better suited as a community package.

New to the WP-CLI codebase? Check out issues labeled ‘good-first-issue’ for a place to start. These issues are specially earmarked for new contributors.

Once you’ve decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it’s a pleasant experience.

Top ↑

Improving our documentation Improving our documentation

Is documentation your strength? Take a look at the currently open documentation issues and see if you can tackle any of those.

If you believe you’ve found an issue with the documentation, you should search existing issues to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version of WP-CLI.

There are a couple different types of documentation currently part of WP-CLI:

  • Documentation for individual WP-CLI commands (anything underneath is contained in the PHPDoc for each command. This means that to edit the documentation for a command, you will need to edit the file that actually provides the functionality for that command. The web documentation is generated from these files at the time of release, so you may not see your changes until the next release.
  • Individual documentation pages (anything under can be edited by contributing to the repository on GitHub. You don’t necessarily need to navigate the Github repo though; any page that is part of this repository will have an ‘Edit’ link in the top right of the page which will take you to the corresponding file on GitHub.

Top ↑

Contributing in other ways Contributing in other ways

Feel free to create an issue with your question, and we’ll see if we can find an answer for it.

Alternatively, if you have a account, you may also consider joining the #cli channel on the Slack organization.