docs: clarify pre-PR contributor checklist by adityachaudhary99 · Pull Request #1920 · Twigpine/openclaude

adityachaudhary99 · 2026-07-09T15:39:13Z

Summary

Add an explicit pre-PR checklist to CONTRIBUTING.md
Require PR descriptions to confirm the contributor reviewed both CONTRIBUTING.md and AGENTS.md
Reinforce duplicate checks, focused scope, and validation expectations

Checks

git diff --check

Copilot

Pull request overview

Updates the contributor workflow documentation by adding an explicit “Before opening a PR” checklist to better align incoming pull requests with the project’s contribution expectations and review process.

Changes:

Adds a pre-PR checklist under the “Pull Requests” section.
Directs contributors to review both CONTRIBUTING.md and AGENTS.md before opening a PR.
Reinforces duplicate-PR avoidance, focused scope, and running appropriate validation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+Before opening a PR:
+
+- Read this `CONTRIBUTING.md` file.
+- Read [`AGENTS.md`](AGENTS.md) for repo-specific coding-agent conventions, validation commands, provider guidance, and architecture rules.
+- Re-check open and recently closed PRs for duplicates.
+- Keep the branch focused on one issue or one clearly scoped improvement.
+- Run the narrowest meaningful validation command for the touched area.


coderabbitai · 2026-07-09T15:43:03Z

📝 Walkthrough

Walkthrough

Updates the Pull Requests section of CONTRIBUTING.md with a pre-opening checklist and a required PR-description confirmation that contributors reviewed CONTRIBUTING.md and AGENTS.md.

Changes

Documentation checklist

Layer / File(s)	Summary
Add pre-PR checklist `CONTRIBUTING.md`	Adds checks for reviewing contribution guidance, finding duplicate PRs, keeping branches narrowly scoped, running targeted validation, and confirming document review in PR descriptions.

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

Possibly related PRs

Gitlawb/openclaude#1676: Both PRs update CONTRIBUTING.md with AI-agent contribution guidance and references to AGENTS.md.

Suggested labels: documentation

Suggested reviewers: copilot, jatmn, kevincodex1, vasanthdev2004

🚥 Pre-merge checks | ✅ 7

✅ Passed checks (7 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	The PR adds the requested pre-PR review checklist and PR-description confirmation for AGENTS.md and CONTRIBUTING.md, matching `#1716`.
Out of Scope Changes check	✅ Passed	The changes stay within the contributor-process docs and do not introduce unrelated code or scope.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Risk Surface Disclosed	✅ Passed	Docs-only change to CONTRIBUTING.md; no auth/routing/permissions/runtime surfaces were touched, so the risk-surface review is not applicable.
No Hidden Policy Change	✅ Passed	Only CONTRIBUTING.md changed, adding an explicit PR-description confirmation; no product, trust, routing, telemetry, or permission policy is hidden in cleanup.
Title check	✅ Passed	The title is concise and accurately reflects the docs-only change to the pre-PR contributor checklist.
Description check	✅ Passed	The description covers the summary and validation, but it omits the Impact and Notes sections from the template.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

coderabbitai

🧹 Nitpick comments (1)

CONTRIBUTING.md (1)
57-64: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Consider adding explicit confirmation of doc review to PR description checklist.

The linked issue asks contributors to confirm in the PR description that they've reviewed both CONTRIBUTING.md and AGENTS.md. The new "Before opening a PR" list (Lines 49-56) covers reading both docs, but the description requirements below don't require stating this was done.
📝 Suggested addition
 - what changed and why
 - the user or developer impact
 - the exact checks you ran
+- confirmation that you've reviewed `CONTRIBUTING.md` and `AGENTS.md`
 - a linked issue when one exists, using `Fixes `#123``, `Closes `#123``, or another clear link
🤖 Prompt for 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.

In `@CONTRIBUTING.md` around lines 57 - 64, Add an explicit PR description
checklist item in the PR requirements section to confirm the contributor
reviewed both CONTRIBUTING.md and AGENTS.md. Update the checklist near the
existing PR description bullets so it clearly requires stating that both docs
were read, matching the new “Before opening a PR” guidance.

🤖 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.

Nitpick comments:
In `@CONTRIBUTING.md`:
- Around line 57-64: Add an explicit PR description checklist item in the PR
requirements section to confirm the contributor reviewed both CONTRIBUTING.md
and AGENTS.md. Update the checklist near the existing PR description bullets so
it clearly requires stating that both docs were read, matching the new “Before
opening a PR” guidance.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 206b0a51-f548-4a61-a00a-cea8e703557c

📥 Commits

Reviewing files that changed from the base of the PR and between 87c457c and d291db2.

📒 Files selected for processing (1)

CONTRIBUTING.md

jatmn

Findings

[P2] Complete CodeRabbit's requested PR-description confirmation
CONTRIBUTING.md:57
Issue #1716 specifically requires contributors to confirm in the PR description that they reviewed both CONTRIBUTING.md and AGENTS.md. This patch only adds a pre-submission reminder at lines 49-55, while the required-description list still has no such confirmation. Please complete the unresolved CodeRabbit review item by adding the confirmation to that list.

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

adityachaudhary99 · 2026-07-13T17:04:04Z

Addressed the review in 2e2b327: PR descriptions must now explicitly confirm that the contributor reviewed both CONTRIBUTING.md and AGENTS.md. The branch was also rebased onto current main.

jatmn

@kevincodex1 LGTM

Copilot AI review requested due to automatic review settings July 9, 2026 15:39

Copilot started reviewing on behalf of adityachaudhary99 July 9, 2026 15:39 View session

Copilot AI reviewed Jul 9, 2026

View reviewed changes

coderabbitai Bot reviewed Jul 9, 2026

View reviewed changes

jatmn requested changes Jul 9, 2026

View reviewed changes

adityachaudhary99 added 2 commits July 13, 2026 20:57

docs: clarify pre-PR contributor checklist

2f156b4

docs: require contribution guide confirmation

2e2b327

Copilot AI review requested due to automatic review settings July 13, 2026 17:00

adityachaudhary99 force-pushed the docs/contributor-process-1716 branch from d291db2 to 2e2b327 Compare July 13, 2026 17:00

Copilot started reviewing on behalf of adityachaudhary99 July 13, 2026 17:01 View session

Copilot AI reviewed Jul 13, 2026

View reviewed changes

coderabbitai Bot approved these changes Jul 13, 2026

View reviewed changes

jatmn approved these changes Jul 13, 2026

View reviewed changes

kevincodex1 approved these changes Jul 14, 2026

View reviewed changes

kevincodex1 merged commit 2da3e4c into Twigpine:main Jul 14, 2026
5 checks passed

adityachaudhary99 deleted the docs/contributor-process-1716 branch August 21, 2026 16:57

Navigation Menu

Repository navigation

docs: clarify pre-PR contributor checklist - #1920

docs: clarify pre-PR contributor checklist#1920
kevincodex1 merged 2 commits into
Twigpine:mainfrom
adityachaudhary99:docs/contributor-process-1716

adityachaudhary99 commented Jul 9, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

coderabbitai Bot commented Jul 9, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

coderabbitai Bot left a comment

Uh oh!

jatmn left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

adityachaudhary99 commented Jul 13, 2026

Uh oh!

jatmn left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

adityachaudhary99 commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checks

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

coderabbitai Bot commented Jul 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

jatmn left a comment

Choose a reason for hiding this comment

Findings

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

adityachaudhary99 commented Jul 13, 2026

Uh oh!

jatmn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

adityachaudhary99 commented Jul 9, 2026 •

edited

Loading

coderabbitai Bot commented Jul 9, 2026 •

edited

Loading