From c816d2455193d11ac8d98d9bba1eeb4353ebf7b0 Mon Sep 17 00:00:00 2001 From: Marcel Rebro Date: Tue, 3 Feb 2026 13:17:16 +0100 Subject: [PATCH] docs: add PR title format requirements to Claude instructions 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 --- .claude/instructions.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/.claude/instructions.md b/.claude/instructions.md index a98b59ccae..d53bf0bd26 100644 --- a/.claude/instructions.md +++ b/.claude/instructions.md @@ -129,6 +129,31 @@ See the `/api-doc` skill for comprehensive OpenAPI specification standards, oper 4. Check all links are valid 5. Ensure front matter is complete +### Creating pull requests + +When creating PRs for this repository, follow these requirements: + +**PR Title Format**: Use [Conventional Commits](https://www.conventionalcommits.org/) format: + +- `docs: ` - Documentation changes (most common) +- `fix: ` - Bug fixes +- `feat: ` - New features +- `chore: ` - Maintenance tasks +- `refactor: ` - Code refactoring +- `test: ` - Test updates + +**Examples**: + +- ✅ `docs: fix grammatical error in residential proxy documentation` +- ✅ `docs: add missing actor.json properties` +- ✅ `fix: correct data retention period in storage docs` +- ❌ `Fix grammatical error` (missing type prefix) +- ❌ `Documentation Update` (wrong format) + +**Enforcement**: PR titles are validated by GitHub Actions. PRs with incorrect titles will fail CI checks. + +**Reference**: See `CONTRIBUTING.md` and `.github/workflows/check-pr-title.yaml` + ### Testing changes ```bash