Skip to content

Commit dc56258

Browse files
marcel-rbroclaude
andauthored
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

File tree

.claude/instructions.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,31 @@ See the `/api-doc` skill for comprehensive OpenAPI specification standards, oper
129129
4. Check all links are valid
130130
5. Ensure front matter is complete
131131

132+
### Creating pull requests
133+
134+
When creating PRs for this repository, follow these requirements:
135+
136+
**PR Title Format**: Use [Conventional Commits](https://www.conventionalcommits.org/) format:
137+
138+
- `docs: <description>` - Documentation changes (most common)
139+
- `fix: <description>` - Bug fixes
140+
- `feat: <description>` - New features
141+
- `chore: <description>` - Maintenance tasks
142+
- `refactor: <description>` - Code refactoring
143+
- `test: <description>` - Test updates
144+
145+
**Examples**:
146+
147+
-`docs: fix grammatical error in residential proxy documentation`
148+
-`docs: add missing actor.json properties`
149+
-`fix: correct data retention period in storage docs`
150+
-`Fix grammatical error` (missing type prefix)
151+
-`Documentation Update` (wrong format)
152+
153+
**Enforcement**: PR titles are validated by GitHub Actions. PRs with incorrect titles will fail CI checks.
154+
155+
**Reference**: See `CONTRIBUTING.md` and `.github/workflows/check-pr-title.yaml`
156+
132157
### Testing changes
133158

134159
```bash

0 commit comments

Comments
 (0)