{"id":18108,"date":"2025-06-12T00:42:40","date_gmt":"2025-06-12T00:42:40","guid":{"rendered":"https:\/\/round-lake.dustinice.workers.dev:443\/https\/make.wordpress.org\/cli\/handbook\/contributing\/"},"modified":"2025-07-01T13:08:15","modified_gmt":"2025-07-01T13:08:15","slug":"contributing","status":"publish","type":"handbook","link":"https:\/\/round-lake.dustinice.workers.dev:443\/https\/make.wordpress.org\/cli\/handbook\/contributions\/contributing\/","title":{"rendered":"Contributing"},"content":{"rendered":"

Welcome and thanks!<\/p>\n

We appreciate you taking the initiative to contribute to WP-CLIWP-CLI<\/span> WP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is https:\/\/round-lake.dustinice.workers.dev:443\/http\/wp-cli.org\/<\/a> https:\/\/round-lake.dustinice.workers.dev:443\/https\/make.wordpress.org\/cli\/<\/a><\/span><\/span><\/span>. It\u2019s because of you, and the community around you, that WP-CLI is such a great project.<\/p>\n

Contributing isn\u2019t limited to just code.<\/strong> We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetupMeetup<\/span> All local\/regional gatherings that are officially a part of the WordPress world but are not WordCamps are organized through https:\/\/round-lake.dustinice.workers.dev:443\/https\/www.meetup.com\/<\/a>. A meetup is typically a chance for local WordPress users to get together and share new ideas and seek help from one another. Searching for \u2018WordPress\u2019 on meetup.com will help you find options in your area.<\/span><\/span><\/span>, helping other users with their support questions, or revising our documentation.<\/p>\n

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\u2019ll do their best to reciprocate that respect when working with you, across timezones and around the world.<\/p>\n

Should you have any questions about contributing, please join the #cli<\/code> channel in the WordPress.org Slack<\/a>.<\/p>\n

Reporting Security Issues<\/h3>\n

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.<\/p>\n

To report a security issue, please visit the WordPress HackerOne<\/a> program.<\/p>\n

Reporting a bug<\/h3>\n

Think you\u2019ve found a bug? We\u2019d love for you to help us get it fixed.<\/p>\n

Before you create a new issue, you should search existing issues<\/a> to see if there\u2019s an existing resolution to it, or if it\u2019s already been fixed in a newer version of WP-CLI. You should also check our documentation on common issues and their fixes<\/a>.<\/p>\n

Once you\u2019ve done a bit of searching and discovered there isn\u2019t an open or fixed issue for your bug, please follow our guidelines for submitting a bug report<\/a> to make sure it gets addressed in a timely manner.<\/p>\n

Creating a pull request<\/h3>\n

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<\/a>, 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.<\/p>\n

New to the WP-CLI codebase? Check out issues labeled \u2018good-first-issue\u2019<\/a> for a place to start. These issues are specially earmarked for new contributors.<\/p>\n

Once you\u2019ve decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request<\/a> to make sure it\u2019s a pleasant experience. See \u201cSetting up<\/a>\u201d for details on making local modifications to WP-CLI. Keep in mind pull requests are expected to have tests<\/a> covering the scope of the change. Read through our code review guidelines<\/a> for a better understanding of how your pull request will be evaluated.<\/p>\n

Improving our documentation<\/h3>\n

Is documentation your strength? Take a look at the currently open documentation issues<\/a> and see if you can tackle any of those.<\/p>\n

There are a couple different types of documentation currently part of WP-CLI:<\/p>\n