Welcome and thanks!
We appreciate you taking the initiative to contribute to WP-CLI. It鈥檚 because of you, and the community around you, that WP-CLI is such a great project.
Contributing isn鈥檛 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 in depth. Following the guidelines helps to communicate that you respect the time of the other contributors to the project. In turn, they鈥檒l do their best to reciprocate that respect when working with you, across timezones and around the world.
Should you have any questions about contributing, please join the #cli channel in the WordPress.org Slack.
The WP-CLI team and WordPress community take security bugs seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.
To report a security issue, please visit the WordPress HackerOne program.
Think you鈥檝e found a bug? We鈥檇 love for you to help us get it fixed.
Before you create a new issue, you should search existing issues to see if there鈥檚 an existing resolution to it, or if it鈥檚 already been fixed in a newer version of WP-CLI. You should also check our documentation on common issues and their fixes.
Once you鈥檝e done a bit of searching and discovered there isn鈥檛 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.
Want to contribute a new feature? WP-CLI is a mature project, and already chock-full of useful functionality. 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.
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. See "Setting up" for details on making local modifications to WP-CLI. Keep in mind pull requests are expected to have tests covering the scope of the change. Read through our code review guidelines for a better understanding of how your pull request will be evaluated.
Is documentation your strength? Take a look at the currently open documentation issues and see if you can tackle any of those.
There are a couple different types of documentation currently part of WP-CLI:
- Documentation for individual WP-CLI commands (anything underneath developer.wordpress.org/commands) 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 make.wordpress.org/cli/handbook) can be edited by contributing to the handbook 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.
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 WordPress.org account, you may also consider joining the #cli channel on the WordPress.org Slack organization.