-
Notifications
You must be signed in to change notification settings - Fork 355
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?
Document WP-CLI contributor badge and association process #617
Conversation
Summary of ChangesHello @iamsohilvahora, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces comprehensive documentation for the WP-CLI Contributor Badge into the project handbook. The primary goal is to provide clear guidelines on how contributors can earn and display this badge on their WordPress.org profiles, thereby enhancing transparency and recognizing valuable contributions to the WP-CLI project. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
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.
Code Review
This pull request introduces documentation for the WP-CLI Contributor Badge, outlining the process for eligibility and assignment. The new handbook page is clear and informative. I've made a few suggestions to enhance formatting and add some useful links to improve the reader's experience.
| 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. |
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.
| 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. | |
| 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. |
| The official association page can be found here: | ||
| 👉 https://profiles.wordpress.org/associations/cli-contributor |
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 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.
| The official association page can be found here: | |
| 👉 https://profiles.wordpress.org/associations/cli-contributor | |
| The official association page can be found here: | |
| 👉 https://profiles.wordpress.org/associations/cli-contributor |
|
|
||
| If you are new to WP-CLI contributions: | ||
|
|
||
| - Read the [Contributing](https://make.wordpress.org/cli/handbook/contributions/) guide |
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.
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.
| - Read the [Contributing](https://make.wordpress.org/cli/handbook/contributions/) guide | |
| - Read the [Contributing](https://make.wordpress.org/cli/handbook/contributions/contributing/) guide |
|
|
||
| - Read the [Contributing](https://make.wordpress.org/cli/handbook/contributions/) guide | ||
| - Look for open issues in WP-CLI repositories | ||
| - Join a WP-CLI Hack Day or WordCamp Contributor Day |
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.
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.
| - Join a WP-CLI Hack Day or WordCamp Contributor Day | |
| - Join a [WP-CLI Hack Day](https://make.wordpress.org/cli/handbook/contributions/hack-day/) or [WordCamp Contributor Day](https://make.wordpress.org/cli/handbook/contributions/contributor-day/) |
Description
This PR documents the WP-CLI Contributor Badge process in the handbook.
Changes included
https://profiles.wordpress.org/associations/cli-contributor
handbook-manifest.jsonto include the new pageRelated
Inspired by the Core AI Contributor Badge documentation.