Skip to content

docs: require complete AI contributor PR template#6601

Merged
matthewevans merged 2 commits into
mainfrom
ship/docs-require-complete-ai-contributor-pr-template
Jul 24, 2026
Merged

docs: require complete AI contributor PR template#6601
matthewevans merged 2 commits into
mainfrom
ship/docs-require-complete-ai-contributor-pr-template

Conversation

@matthewevans

@matthewevans matthewevans commented Jul 24, 2026

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidance to require using the standard pull request template and completing every section.
    • Clarified how contributors should report the AI model and tier used.
    • Added structured reporting fields for scope expansion, validation failures, and CI failures.
    • Aligned README and AI contributor instructions with the updated pull request process.

@matthewevans
matthewevans enabled auto-merge July 24, 2026 18:28
@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@matthewevans, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 4 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: c97ba0fe-1818-44d4-b2d4-0160ff4e2296

📥 Commits

Reviewing files that changed from the base of the PR and between ff204c0 and 2ec8204.

📒 Files selected for processing (2)
  • .github/PULL_REQUEST_TEMPLATE.md
  • docs/AI-CONTRIBUTOR.md
📝 Walkthrough

Walkthrough

The PR updates the pull-request template with structured LLM and parse-impact metadata, then aligns contributor documentation and AI prompts to require that template and canonical model and tier fields.

Changes

PR guidance standardization

Layer / File(s) Summary
Template metadata and impact fields
.github/PULL_REQUEST_TEMPLATE.md
Adds Files changed, Track, LLM, Model, and Tier fields, and structures claimed parse impact with scope, validation, and CI subsections.
Contributor instructions alignment
CONTRIBUTING.md, README.md, docs/AI-CONTRIBUTOR.md
Requires LLM contributors to use and complete the repository PR template, including canonical Model: and Tier: Frontier lines across contributor guidance and prompts.

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

Possibly related PRs

  • phase-rs/phase#6579: Updates AI contributor guidance for Frontier-tier model policy in the same documentation area.
  • phase-rs/phase#6584: Expands Frontier model and tier requirements referenced by the updated contributor guidance.
🚥 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 change: documentation updates that require completing the AI contributor PR template.
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 ship/docs-require-complete-ai-contributor-pr-template

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

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 @.github/PULL_REQUEST_TEMPLATE.md:
- Around line 15-17: Update the default pull request template metadata section
containing “Model,” “Tier,” and “Thinking” to provide an explicit not-applicable
option for non-LLM contributors, while retaining the existing guidance for
AI-assisted submissions. Ensure contributors can complete the section truthfully
without providing fabricated Frontier model or thinking details.

In `@docs/AI-CONTRIBUTOR.md`:
- Around line 383-388: Update the embedded pull request template section in
AI-CONTRIBUTOR.md to match .github/PULL_REQUEST_TEMPLATE.md exactly, especially
the parse-diff card-name requirements and Scope Expansion guidance; remove the
conflicting optional-evidence wording rather than maintaining a divergent
duplicate.
🪄 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 Plus

Run ID: 0854ec5b-1b90-4f38-9d2a-f1fa2e02d843

📥 Commits

Reviewing files that changed from the base of the PR and between 7ac9d51 and ff204c0.

📒 Files selected for processing (4)
  • .github/PULL_REQUEST_TEMPLATE.md
  • CONTRIBUTING.md
  • README.md
  • docs/AI-CONTRIBUTOR.md

Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
Comment thread docs/AI-CONTRIBUTOR.md Outdated
@matthewevans
matthewevans disabled auto-merge July 24, 2026 18:39
@matthewevans
matthewevans merged commit 4dd28b1 into main Jul 24, 2026
13 checks passed
@matthewevans
matthewevans deleted the ship/docs-require-complete-ai-contributor-pr-template branch July 24, 2026 18:40
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