Merged
Conversation
Revised the `CONTRIBUTING.md`. Signed-off-by: Ryan Johnson <ryan.johnson@broadcom.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the CONTRIBUTING.md file to provide more comprehensive and structured guidelines for contributors. The changes improve clarity, add modern GitHub markdown alert syntax (TIP, WARNING, IMPORTANT), and provide more detailed step-by-step instructions for both issues and pull requests.
Changes:
- Enhanced the Issues section with structured guidelines, warnings, and helpful tips for contributors
- Expanded the Pull Requests section with detailed before/after submission checklists and specific make commands
- Added new sections for resolving review comments and requesting follow-up reviews
- Updated link references to include the Broadcom Product Lifecycle
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 1. You have [opened a discussion][gh-discussions] to discuss any **significant** work with | ||
| the maintainer(s). This ensures that your contribution is aligned with the | ||
| project's direction and avoids unnecessary work. | ||
| 2. You have identified or [open an issue][gh-issues]. This ensures that your contribution |
There was a problem hiding this comment.
Inconsistent verb tense in the sentence. The phrase should be "You have identified or opened an issue" (past tense) to match the pattern used in the rest of the list items which all use "You have [past tense verb]".
Suggested change
| 2. You have identified or [open an issue][gh-issues]. This ensures that your contribution | |
| 2. You have identified or [opened an issue][gh-issues]. This ensures that your contribution |
| 5. You have modified the source based on logical units of work. Focus on the specific change | ||
| you are contributing. Pull requests that contain multiple unrelated changes will be | ||
| rejected. | ||
| 4. You have followed the existing style and conventions of the project. |
There was a problem hiding this comment.
Trailing whitespace at the end of the line. This should be removed for consistency and to follow standard markdown formatting conventions.
Suggested change
| 4. You have followed the existing style and conventions of the project. | |
| 4. You have followed the existing style and conventions of the project. |
| 2. You provide a detailed description of the changes in the pull request template. | ||
| 2. You open any work-in-progress pull requests as a draft. | ||
| 3. You mark the pull request as ready for review when you are ready for it to be reviewed. | ||
| 4. You follow the status checks for the pull request to ensure that all checks are passing. |
There was a problem hiding this comment.
Trailing whitespace at the end of the line. This should be removed for consistency and to follow standard markdown formatting conventions.
Comment on lines
+54
to
+75
| 3. You are working against the latest source on the `main` branch. You may need to | ||
| rebase your branch against the latest `main` branch. | ||
| 4. You have created a topic branch based on `main`. Do not work directly on the `main` branch. | ||
| 5. You have modified the source based on logical units of work. Focus on the specific change | ||
| you are contributing. Pull requests that contain multiple unrelated changes will be | ||
| rejected. | ||
| 4. You have followed the existing style and conventions of the project. | ||
| 5. You have added tests for your changes. | ||
| 5. You have generated the updated documentation and associated assets by running `make generate`. | ||
| 5. You have tested building the plugin by running `make build`. | ||
| 7. You have tested your changes with a local build of the plugin by running `make dev`. | ||
| 9. You have verified all new and existing tests are passing by running `make test`. | ||
| 10. You have used [Conventional Commits][conventional-commits] format for commit messages. | ||
| 11. You have signed-off and committed your changes [using clear commit messages][git-commit]. | ||
|
|
||
| When opening a pull request, ensure that: | ||
|
|
||
| 1. You title your pull request using the [Conventional Commits][conventional-commits] format. | ||
| 2. You provide a detailed description of the changes in the pull request template. | ||
| 2. You open any work-in-progress pull requests as a draft. | ||
| 3. You mark the pull request as ready for review when you are ready for it to be reviewed. | ||
| 4. You follow the status checks for the pull request to ensure that all checks are passing. |
There was a problem hiding this comment.
The numbered list contains duplicate and incorrect numbering. The sequence is: 1, 2, 3, 3, 4, 5, 4, 5, 5, 5, 7, 9, 10, 11. This should be a consecutive sequence from 1 to 11. The numbering should be: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11.
Suggested change
| 3. You are working against the latest source on the `main` branch. You may need to | |
| rebase your branch against the latest `main` branch. | |
| 4. You have created a topic branch based on `main`. Do not work directly on the `main` branch. | |
| 5. You have modified the source based on logical units of work. Focus on the specific change | |
| you are contributing. Pull requests that contain multiple unrelated changes will be | |
| rejected. | |
| 4. You have followed the existing style and conventions of the project. | |
| 5. You have added tests for your changes. | |
| 5. You have generated the updated documentation and associated assets by running `make generate`. | |
| 5. You have tested building the plugin by running `make build`. | |
| 7. You have tested your changes with a local build of the plugin by running `make dev`. | |
| 9. You have verified all new and existing tests are passing by running `make test`. | |
| 10. You have used [Conventional Commits][conventional-commits] format for commit messages. | |
| 11. You have signed-off and committed your changes [using clear commit messages][git-commit]. | |
| When opening a pull request, ensure that: | |
| 1. You title your pull request using the [Conventional Commits][conventional-commits] format. | |
| 2. You provide a detailed description of the changes in the pull request template. | |
| 2. You open any work-in-progress pull requests as a draft. | |
| 3. You mark the pull request as ready for review when you are ready for it to be reviewed. | |
| 4. You follow the status checks for the pull request to ensure that all checks are passing. | |
| 4. You are working against the latest source on the `main` branch. You may need to | |
| rebase your branch against the latest `main` branch. | |
| 5. You have created a topic branch based on `main`. Do not work directly on the `main` branch. | |
| 6. You have modified the source based on logical units of work. Focus on the specific change | |
| you are contributing. Pull requests that contain multiple unrelated changes will be | |
| rejected. | |
| 7. You have followed the existing style and conventions of the project. | |
| 8. You have added tests for your changes. | |
| 9. You have generated the updated documentation and associated assets by running `make generate`. | |
| 10. You have tested building the plugin by running `make build`. | |
| 11. You have tested your changes with a local build of the plugin by running `make dev`. | |
| 12. You have verified all new and existing tests are passing by running `make test`. | |
| 13. You have used [Conventional Commits][conventional-commits] format for commit messages. | |
| 14. You have signed-off and committed your changes [using clear commit messages][git-commit]. | |
| When opening a pull request, ensure that: | |
| 1. You title your pull request using the [Conventional Commits][conventional-commits] format. | |
| 2. You provide a detailed description of the changes in the pull request template. | |
| 3. You open any work-in-progress pull requests as a draft. | |
| 4. You mark the pull request as ready for review when you are ready for it to be reviewed. | |
| 5. You follow the status checks for the pull request to ensure that all checks are passing. |
Comment on lines
+60
to
+76
| 4. You have followed the existing style and conventions of the project. | ||
| 5. You have added tests for your changes. | ||
| 5. You have generated the updated documentation and associated assets by running `make generate`. | ||
| 5. You have tested building the plugin by running `make build`. | ||
| 7. You have tested your changes with a local build of the plugin by running `make dev`. | ||
| 9. You have verified all new and existing tests are passing by running `make test`. | ||
| 10. You have used [Conventional Commits][conventional-commits] format for commit messages. | ||
| 11. You have signed-off and committed your changes [using clear commit messages][git-commit]. | ||
|
|
||
| When opening a pull request, ensure that: | ||
|
|
||
| 1. You title your pull request using the [Conventional Commits][conventional-commits] format. | ||
| 2. You provide a detailed description of the changes in the pull request template. | ||
| 2. You open any work-in-progress pull requests as a draft. | ||
| 3. You mark the pull request as ready for review when you are ready for it to be reviewed. | ||
| 4. You follow the status checks for the pull request to ensure that all checks are passing. | ||
| 5. You stay involved in the conversation with the maintainers to ensure that your contribution |
There was a problem hiding this comment.
The numbered list contains duplicate numbering. The sequence is: 1, 2, 2, 3, 4, 5. Item 3 should be numbered as 3, not 2.
Suggested change
| 4. You have followed the existing style and conventions of the project. | |
| 5. You have added tests for your changes. | |
| 5. You have generated the updated documentation and associated assets by running `make generate`. | |
| 5. You have tested building the plugin by running `make build`. | |
| 7. You have tested your changes with a local build of the plugin by running `make dev`. | |
| 9. You have verified all new and existing tests are passing by running `make test`. | |
| 10. You have used [Conventional Commits][conventional-commits] format for commit messages. | |
| 11. You have signed-off and committed your changes [using clear commit messages][git-commit]. | |
| When opening a pull request, ensure that: | |
| 1. You title your pull request using the [Conventional Commits][conventional-commits] format. | |
| 2. You provide a detailed description of the changes in the pull request template. | |
| 2. You open any work-in-progress pull requests as a draft. | |
| 3. You mark the pull request as ready for review when you are ready for it to be reviewed. | |
| 4. You follow the status checks for the pull request to ensure that all checks are passing. | |
| 5. You stay involved in the conversation with the maintainers to ensure that your contribution | |
| 6. You have followed the existing style and conventions of the project. | |
| 7. You have added tests for your changes. | |
| 8. You have generated the updated documentation and associated assets by running `make generate`. | |
| 9. You have tested building the plugin by running `make build`. | |
| 10. You have tested your changes with a local build of the plugin by running `make dev`. | |
| 11. You have verified all new and existing tests are passing by running `make test`. | |
| 12. You have used [Conventional Commits][conventional-commits] format for commit messages. | |
| 13. You have signed-off and committed your changes [using clear commit messages][git-commit]. | |
| When opening a pull request, ensure that: | |
| 1. You title your pull request using the [Conventional Commits][conventional-commits] format. | |
| 2. You provide a detailed description of the changes in the pull request template. | |
| 3. You open any work-in-progress pull requests as a draft. | |
| 4. You mark the pull request as ready for review when you are ready for it to be reviewed. | |
| 5. You follow the status checks for the pull request to ensure that all checks are passing. | |
| 6. You stay involved in the conversation with the maintainers to ensure that your contribution |
|
This functionality has been released in v2.0.0 of the plugin. For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you! |
1 similar comment
|
This functionality has been released in v2.0.0 of the plugin. For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you! |
|
I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues. If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Revised the
CONTRIBUTING.md.Type
fix: Bug Fixfeat: Feature or Enhancementdocs: Documentationrefactor: Refactoringchore: Build, Dependencies, Workflows, etc.other: Other (Please describe.)Breaking Changes?
Tests
Output:
Documentation
Issue References
Release Note
Additional Information