Commit dc56258
docs: add PR title format requirements to Claude instructions (#2220)
## Summary
Adds PR title format documentation to `.claude/instructions.md` to
prevent AI agents from creating PRs with incorrect titles that fail CI
checks.
## Problem
PR title format requirements were:
- ✅ Documented in `CONTRIBUTING.md:350` (link only, no examples)
- ✅ Enforced by `.github/workflows/check-pr-title.yaml`
- ❌ **Missing from `.claude/instructions.md`** (where AI looks first)
This caused all 4 Phase 1 PRs (#2216, #2217, #2218, #2219) to initially
fail CI checks and require manual title corrections.
## Solution
Added new "Creating pull requests" section in `.claude/instructions.md`
with:
- **Format requirements**: Conventional Commits (`docs:`, `fix:`,
`feat:`, etc.)
- **Clear examples**: Both correct (✅) and incorrect (❌) formats
- **Enforcement notice**: GitHub Actions validation
- **References**: Links to `CONTRIBUTING.md` and workflow file
## Location
Added after line 130 in the "Before submitting" section to keep all
pre-submission requirements together.
## Benefits
1. **Prevents errors**: AI agents know correct format upfront
2. **Faster workflow**: No manual fixes needed after PR creation
3. **Self-documenting**: Instructions where AI looks first
4. **Consistent**: Aligns with other pre-submission checks
## Testing
- [x] Section added to correct location
- [x] Markdown formatting correct (no linting errors)
- [x] Examples are clear and actionable
- [x] Consistent with existing documentation style
---
🤖 Generated with Claude Code
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> **Low Risk**
> Documentation-only change with no code or workflow logic
modifications; risk is limited to potential confusion if the guidance is
inaccurate.
>
> **Overview**
> Adds a new **“Creating pull requests”** section to
`.claude/instructions.md` that documents the required **Conventional
Commits** PR title format, with accepted type prefixes, good/bad
examples, and a note that CI enforces this via the PR title check
workflow (with references to `CONTRIBUTING.md` and
`.github/workflows/check-pr-title.yaml`).
>
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
c816d24. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>1 parent 84ba01d commit dc56258
1 file changed
Lines changed: 25 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
129 | 129 | | |
130 | 130 | | |
131 | 131 | | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
132 | 157 | | |
133 | 158 | | |
134 | 159 | | |
| |||
0 commit comments