Repository navigation
docs: add GitHub template governance guidance for AI agents - #1080
ashleyshaw wants to merge 1 commit into
Conversation
|
Warning Review limit reached
Next review available in: 35 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the 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 configurationConfiguration used: Repository YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Added comprehensive guidance to help AI agents create compliant pull requests and issues: - AGENTS.md: New 'GitHub Template Governance' section with: * Pull request template guidance (preventative enforcement) * Issue template guidance (reactive with pre-flight validation) * 25 issue types mapped to template files * Programmatic creation patterns with code examples * JavaScript validation function * Complete bash example - CLAUDE.md: New 'Issue Template Quick Reference' section with: * Quick lookup table mapping issue types to templates * Mandatory sections emphasized (Definition of Ready & Done) * Cross-reference to AGENTS.md for detailed guidance This enables AI agents to create template-compliant issues programmatically, avoiding post-creation flagging with status:needs-more-info. Addresses #1078 Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
🔍 Reviewer Summary for PR #1080CI Status: ✅ Recommendations
|
7a3cfca to
6ad8dbc
Compare
Pull request was closed
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7a3cfcae23
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| ``` | ||
| .github/ISSUE_TEMPLATE/ | ||
| ├── 01-bug.md |
There was a problem hiding this comment.
Use the repository's actual issue-template filenames
For programmatic bug, refactor, task, chore, testing, performance, accessibility, security, compatibility, build, and automation issues, this inventory points agents at either a nonexistent file or the wrong issue type. The current tree starts with 01-task.md, 02-bug.md, and 09-code-refactor.md, while testing through compatibility are numbered 12–16; consequently the bug example's cat .github/ISSUE_TEMPLATE/01-bug.md fails and the duplicated CLAUDE.md table is also unusable. Replace both maps with the canonical filenames from the template directory.
AGENTS.md reference: AGENTS.md:L118-L124
Useful? React with 👍 / 👎.
| - All issue templates require: | ||
| - `## Definition of Ready (DoR)` — pre-work checklist | ||
| - `## Definition of Done (DoD)` — completion checklist |
There was a problem hiding this comment.
Account for templates that lack the mandatory sections
When an agent creates a testing-coverage, performance, research, audit, AI-ops, or content-modelling issue, the official template contains neither or both of these asserted headings, so extracting the template and running the supplied JavaScript validator prevents creation. Either add DoR and DoD to .github/ISSUE_TEMPLATE/12-testing-coverage.md, 13-performance.md, 21-research.md, 22-audit.md, 24-ai-ops.md, and 25-content-modelling.md, or document that automation must synthesise the missing sections rather than claiming every template already provides them.
AGENTS.md reference: AGENTS.md:L120-L124
Useful? React with 👍 / 👎.
| $DOD" | ||
|
|
||
| # Validate | ||
| if ! echo "$BODY" | grep -q "Definition of Ready\|Definition of Done"; then |
There was a problem hiding this comment.
Require both headings in the shell validation
If extraction or future template changes leave only one required section in BODY, this grep still succeeds because \| is alternation, and the script proceeds to gh issue create; .github/workflows/template-enforcement.yml tests DoR and DoD independently and will then flag the issue. Validate each heading separately so this advertised pre-posting check enforces the stated requirement that both are present.
AGENTS.md reference: AGENTS.md:L193-L199
Useful? React with 👍 / 👎.
Metadata governance
|
Documentation Pull Request
Linked issues
Relates to #1078
What changed
Audience & placement
Changelog
Added
Checklist (Global DoD / PR)
🤖 Created via proper GitHub workflow: Issue → Branch → PR → Merge