Skip to content

docs(contributing): add contribution volume and batching guidance#783

Merged
kevincodex1 merged 1 commit into
mainfrom
docs/contributing-volume-batching
Jul 21, 2026
Merged

docs(contributing): add contribution volume and batching guidance#783
kevincodex1 merged 1 commit into
mainfrom
docs/contributing-volume-batching

Conversation

@Vasanthdev2004

@Vasanthdev2004 Vasanthdev2004 commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator

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

  • Documentation
    • Added contribution guidance covering submission size, batching related findings, and limiting open issues and pull requests.
    • Clarified verification expectations for AI-assisted contributions.
    • Documented that maintainers may request consolidation, splitting, or delayed submissions to keep reviews manageable.

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.
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

CONTRIBUTING.md adds a “Contribution Volume and Batching” section describing submission batching, limits on simultaneous open items, verification of AI-assisted contributions, and maintainer requests to consolidate, split, or hold submissions.

Changes

Contribution guidance

Layer / File(s) Summary
Add contribution volume and batching rules
CONTRIBUTING.md
Documents limits for bundled findings and simultaneous open issues or pull requests, requires individual verification of AI-assisted contributions, and describes maintainer requests for consolidation, splitting, or delayed submissions.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

  • Gitlawb/zero#734: Updates contributor and pull request process documentation with scope and required-check expectations.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the documentation-only change adding contribution volume and batching guidance to CONTRIBUTING.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/contributing-volume-batching

Comment @coderabbitai help to get the list of available commands.

@Vasanthdev2004
Vasanthdev2004 requested a review from jatmn July 21, 2026 05:57

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3967d49 and da050ef.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md
@Vasanthdev2004

Copy link
Copy Markdown
Collaborator Author

@coderabbitai approve

@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown
✅ Action performed

Comments resolved and changes approved.

@github-actions

Copy link
Copy Markdown
Contributor

Zero automated PR review

Verdict: No blockers found

Blockers

  • None found.

Validation

  • [pass] Diff hygiene: git diff --check
  • [pass] Tests: go test ./...
  • [pass] Build: go run ./cmd/zero-release build
  • [pass] Smoke build: go run ./cmd/zero-release smoke

Scope

Head: da050ef23ab8
Changed files (1): CONTRIBUTING.md

This deterministic review checks validation status and basic diff hygiene. A human reviewer still owns product judgment and design quality.

@kevincodex1
kevincodex1 merged commit 5140d4b into main Jul 21, 2026
9 checks passed
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.

4 participants