docs(contributing): add contribution volume and batching guidance#783
Conversation
Documents expectations for keeping contribution flow sustainable during the stabilization phase: one issue per bug (no bundled multi-finding audits), keep only a few items open at a time, and hold AI-assisted contributions to the same per-item verification bar. Complements the existing issue-approved gate, which already covers PR-to-issue linkage and scope; the gap was submission volume.
Walkthrough
ChangesContribution guidance
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 79-82: Update the contribution guidance near “Keep only a few
items open at a time” to define the simultaneous open-item limit explicitly,
either by stating a concrete maximum or by saying maintainers determine the
threshold. Preserve the existing queue and review guidance.
- Around line 83-86: Update the AI-assisted contributions guidance in
CONTRIBUTING.md so reproducibility is required for reported defects, while
generated patches and every pull request require individual verification and
appropriate scoping. Remove the blanket requirement that each pull request be
reproducible, and retain the restriction against posting unfiltered bulk
machine-generated findings.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: cbcdd305-e3b6-438c-807c-a3bc038fb8b2
📒 Files selected for processing (1)
CONTRIBUTING.md
|
@coderabbitai approve |
✅ Action performedComments resolved and changes approved. |
Zero automated PR reviewVerdict: No blockers found Blockers
Validation
ScopeHead: This deterministic review checks validation status and basic diff hygiene. A human reviewer still owns product judgment and design quality. |
What
Adds a "Contribution Volume and Batching" section to CONTRIBUTING.md.
Why
The current policy already covers the issue-approved gate, PR-to-issue linkage, and scope discipline. What it does not address is submission volume: bulk multi-finding "audit" issues, and large simultaneous bursts from a single contributor, strain triage and review even when every item is individually valid. This section sets uniform expectations for all contributors so the queue stays manageable during the stabilization phase.
Scope
Docs only, no code or behavior change. Internal policy update by the core team.
Summary by CodeRabbit