Skip to content

docs: add pull request guidelines to CONTRIBUTING.md - #967

Open
dims wants to merge 1 commit into
mainfrom
contrib-guidelines-bulk-prs
Open

docs: add pull request guidelines to CONTRIBUTING.md#967
dims wants to merge 1 commit into
mainfrom
contrib-guidelines-bulk-prs

Conversation

@dims

@dims dims commented Aug 13, 2026

Copy link
Copy Markdown

Summary

  • Add a new Pull Request Guidelines section to CONTRIBUTING.md.
  • Covers grouping cross-distro fixes by root cause, opening issues before bulk submissions, CI rate courtesy, conflict avoidance, separating cosmetic from correctness changes, writing executable tests, and linking PRs to issues.

Motivation

The repo received a large batch of AI-generated PRs on a single day (49 open PRs, all same date, many targeting the same file and same root cause). Clear written guidance helps both AI agents and human contributors structure contributions in a way that is reviewable and CI-friendly.

Test plan

  • Read the updated CONTRIBUTING.md and verify the guidance is clear and actionable.

Add a new section covering how to structure PRs well:
- group cross-distro fixes for the same root cause into one PR
- open an issue before sending bulk fixes
- avoid opening many PRs in a single session to protect shared CI
- check for existing open PRs on the same file to prevent conflicts
- separate cosmetic changes from correctness fixes
- write tests that execute code, not just grep for old patterns
- link every PR to an issue

Signed-off-by: Davanum Srinivas <dsrinivas@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant