-
Notifications
You must be signed in to change notification settings - Fork 356
Document WP-CLI contributor badge and association process #617
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,64 @@ | ||||||||||||
| # WP-CLI Contributor Badge | ||||||||||||
|
|
||||||||||||
| The **WP-CLI Contributor Badge** recognizes individuals who have made meaningful contributions to the WP-CLI project. | ||||||||||||
| This badge is displayed on a contributor’s WordPress.org profile and highlights their involvement in maintaining and improving WP-CLI. | ||||||||||||
|
|
||||||||||||
| --- | ||||||||||||
|
|
||||||||||||
| ## What is the WP-CLI Contributor Badge? | ||||||||||||
|
|
||||||||||||
| The WP-CLI Contributor Badge is an official WordPress.org profile badge awarded to contributors who actively participate in the WP-CLI project through code, documentation, reviews, testing, triage, or community support. | ||||||||||||
|
|
||||||||||||
| The badge is managed via the WordPress.org profile association system. | ||||||||||||
|
|
||||||||||||
| --- | ||||||||||||
|
|
||||||||||||
| ## Eligibility criteria | ||||||||||||
|
|
||||||||||||
| You may be eligible for the WP-CLI Contributor Badge if you have made consistent and valuable contributions such as: | ||||||||||||
|
|
||||||||||||
| - Submitting pull requests to WP-CLI repositories | ||||||||||||
| - Reviewing or testing pull requests | ||||||||||||
| - Reporting bugs or helping triage issues | ||||||||||||
| - Improving documentation in the WP-CLI handbook | ||||||||||||
| - Participating in WP-CLI Hack Days or Contributor Days | ||||||||||||
| - Supporting users in WP-CLI-related discussions | ||||||||||||
|
|
||||||||||||
| There is no strict minimum requirement. Contributions are evaluated based on quality, impact, and consistency. | ||||||||||||
|
|
||||||||||||
| --- | ||||||||||||
|
|
||||||||||||
| ## Badge assignment process | ||||||||||||
|
|
||||||||||||
| The WP-CLI Contributor Badge is assigned through the WordPress.org **profile associations** system. | ||||||||||||
|
|
||||||||||||
| ### How it works | ||||||||||||
|
|
||||||||||||
| 1. WP-CLI maintainers review contributor activity across WP-CLI repositories and documentation. | ||||||||||||
| 2. Eligible contributors are added to the **WP-CLI Contributors association**. | ||||||||||||
| 3. Once associated, the **WP-CLI Contributor Badge** automatically appears on the contributor’s WordPress.org profile. | ||||||||||||
|
|
||||||||||||
| The official association page can be found here: | ||||||||||||
| 👉 https://profiles.wordpress.org/associations/cli-contributor | ||||||||||||
|
Comment on lines
+41
to
+42
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For consistency and improved readability, it would be better to use a paragraph break (a blank line) to separate the introductory text from the link, instead of a hard line break.
Suggested change
|
||||||||||||
|
|
||||||||||||
| --- | ||||||||||||
|
|
||||||||||||
| ## Missing the badge? | ||||||||||||
|
|
||||||||||||
| If you believe you qualify for the WP-CLI Contributor Badge but do not see it on your profile: | ||||||||||||
|
|
||||||||||||
| - Confirm that your GitHub account is linked to your WordPress.org profile | ||||||||||||
| - Ensure your contributions are publicly visible (PRs, issues, reviews) | ||||||||||||
| - Reach out to WP-CLI maintainers with links to your contributions for review | ||||||||||||
|
|
||||||||||||
| --- | ||||||||||||
|
|
||||||||||||
| ## Get started contributing | ||||||||||||
|
|
||||||||||||
| If you are new to WP-CLI contributions: | ||||||||||||
|
|
||||||||||||
| - Read the [Contributing](https://make.wordpress.org/cli/handbook/contributions/) guide | ||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The link for the "Contributing" guide appears to point to the general "Contributions" index page. To provide a more direct path for users, consider updating it to link directly to the specific "Contributing" guide.
Suggested change
|
||||||||||||
| - Look for open issues in WP-CLI repositories | ||||||||||||
| - Join a WP-CLI Hack Day or WordCamp Contributor Day | ||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. To make it easier for new contributors to find relevant information, it would be helpful to add direct links to the "WP-CLI Hack Day" and "WordCamp Contributor Day" handbook pages.
Suggested change
|
||||||||||||
|
|
||||||||||||
| Your contributions help strengthen the WP-CLI ecosystem and the wider WordPress community 💙 | ||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For better readability and standard markdown practice, it's recommended to use a blank line to create a new paragraph instead of using two spaces for a hard line break.