docs: add PR title format requirements to Claude instructions#2220
Merged
marcel-rbro merged 1 commit intomasterfrom Feb 3, 2026
Merged
docs: add PR title format requirements to Claude instructions#2220marcel-rbro merged 1 commit intomasterfrom
marcel-rbro merged 1 commit intomasterfrom
Conversation
Add documentation about PR title format requirements using Conventional Commits to .claude/instructions.md. This prevents AI agents from creating PRs with incorrect titles that fail CI checks. Includes: - Required format (docs:, fix:, feat:, etc.) - Clear examples of correct and incorrect titles - Reference to enforcement via GitHub Actions This documentation gap caused 4 PRs to initially fail CI checks and required manual title corrections. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
|
Preview for this PR was built for commit |
TC-MO
approved these changes
Feb 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds PR title format documentation to
.claude/instructions.mdto prevent AI agents from creating PRs with incorrect titles that fail CI checks.Problem
PR title format requirements were:
CONTRIBUTING.md:350(link only, no examples).github/workflows/check-pr-title.yaml.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.mdwith:docs:,fix:,feat:, etc.)CONTRIBUTING.mdand workflow fileLocation
Added after line 130 in the "Before submitting" section to keep all pre-submission requirements together.
Benefits
Testing
🤖 Generated with Claude Code
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.mdthat 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 toCONTRIBUTING.mdand.github/workflows/check-pr-title.yaml).Written by Cursor Bugbot for commit c816d24. Configure here.