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