Update the CONTRIBUTING.md to build quality in the recent PRs - #2301
Update the CONTRIBUTING.md to build quality in the recent PRs#2301sayanchowdhury wants to merge 3 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
Updates CONTRIBUTING.md with additional contributor and maintainer guidance aimed at reducing low-effort / spammy issues and PRs, including explicit expectations for AI-assisted submissions and clearer issue-triage norms.
Changes:
- Adds new guidance sections covering AI-assisted contributions, PR etiquette, issue assignment expectations, issue quality requirements, and how to report spam/abuse/security issues.
- Expands “Finding Issues” guidance to require a short, contributor-written plan (and discourages AI-generated “claim” comments).
- Cleans up a few formatting/details in the commit message guidelines examples and rules table.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
967911c to
7f4936c
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
CONTRIBUTING.md:95
- The PR description says "no-em dashes", but this newly added text introduces an em dash (—). Either update the PR description to reflect current formatting intent, or adjust the new text to avoid em dashes for consistency with the stated goal.
Found something you'd like to work on? Excellent! Just leave a comment like
"I'd like to work on this" — that's all it takes to claim it.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
CONTRIBUTING.md:95
- This implies that a simple “I’d like to work on this” comment is enough to claim an issue, but the new “Issue Assignment” section later explicitly says contributors should include an intended approach and that issues won’t be formally assigned until there’s a draft PR. This is internally inconsistent guidance and will confuse new contributors.
Found something you'd like to work on? Excellent! Just leave a comment like
"I'd like to work on this" — that's all it takes to claim it.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
CONTRIBUTING.md:357
- In the label list, add a comma before “or other label” for correct punctuation; as written, it reads like
kind/security or otheris a single label.
For new features or larger work, assign the issue to the developer if
known, or add a `kind/release`, `kind/packages`, `kind/security` or other label
once the owning group is absolutely clear, and link it to the relevant milestone.
Signed-off-by: Sayan Chowdhury <sayan.chowdhury2012@gmail.com>
Signed-off-by: Sayan Chowdhury <sayan.chowdhury2012@gmail.com>
ea4ba7b to
0714e47
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (2)
CONTRIBUTING.md:388
- Spelling is inconsistent with the rest of the repository’s docs: elsewhere the project uses “behavior” (e.g., RELEASES.md), but this new section uses “behaviour”.
- Expected vs. actual behaviour
CONTRIBUTING.md:39
- The new Table of Contents entries (AI-Assisted Contributions, Pull Request Etiquette, etc.) are indented as siblings of “Authoring PRs”, but their corresponding headings are
###sections inside the “Authoring PRs” section. This breaks the TOC hierarchy and makes these entries appear as top-level Development items rather than sub-items of Authoring PRs.
- [AI-Assisted Contributions](#ai-assisted-contributions)
- [Pull Request Etiquette](#pull-request-etiquette)
- [Issue Assignment](#issue-assignment)
- [Issue Quality Bar](#issue-quality-bar)
- [Coordinated or Bulk-Filed Issues and PRs](#coordinated-or-bulk-filed-issues-and-prs)
|
|
||
| Please don't @-mention multiple maintainers in a PR or issue comment to | ||
| request review or ask to be assigned. This creates notification noise and | ||
| doesn't speed things up. If a PR has been open for a while without |
There was a problem hiding this comment.
I think we need to specify what "a while" means
There was a problem hiding this comment.
What "a while" means comes right below in the text. say 2-3 weeks, but contributors are advised to use their own judgment. :-)
Signed-off-by: Sayan Chowdhury <sayan.chowdhury2012@gmail.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
CONTRIBUTING.md:411
- The table of contents links to a non-existent
#reporting-spam-or-abusesection. The closest matching section below is titledLow-Quality Activity Is Discouraged, so the TOC entry currently becomes a broken link.
### Low-Quality Activity Is Discouraged
Update the CONTRIBUTING.md to build quality in the recent PRs
AI has been used to grammar check the change and sentence restructing whereever required, and review em dashes. I've read through the suggested change and updated whereever required