Skip to content
This repository was archived by the owner on Feb 24, 2026. It is now read-only.

Commit a9acf36

Browse files
docs: add root AGENTS.md with conventional commit conventions (#10)
Adds agent instructions for the projectuner repo itself (not the template) covering repo structure, PR title format, Release Please types, and the release workflow. Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 01bb5a4 commit a9acf36

2 files changed

Lines changed: 58 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Agent Instructions
2+
3+
Copier template that scaffolds git projects using the bare repo + worktree pattern.
4+
5+
## Repository structure
6+
7+
```
8+
copier.yml Copier template configuration
9+
template/ Template files copied to new projects
10+
setup.sh.jinja Post-copy scaffolding script
11+
.mise/tasks/ Mise task scripts for worktree management
12+
AGENTS.md Agent instructions for scaffolded projects
13+
scripts/
14+
convert-to-worktree Converts an existing git clone to worktree structure
15+
```
16+
17+
## PR title conventions
18+
19+
This project uses **Release Please** for automated versioning and changelog generation.
20+
PR titles must follow **conventional commit format** because they become the commit message
21+
after squash-merge.
22+
23+
### Format
24+
25+
```text
26+
<type>[optional scope]: <description>
27+
```
28+
29+
### Types
30+
31+
| Type | Changelog section | Version bump |
32+
|------|-------------------|--------------|
33+
| `feat:` | Features | MINOR |
34+
| `fix:` | Bug Fixes | PATCH |
35+
| `docs:` | Documentation Updates | PATCH |
36+
| `chore:` | Miscellaneous Chores | PATCH |
37+
| `refactor:` | Code Refactoring | PATCH |
38+
| `test:` | Tests | PATCH |
39+
| `perf:` | Performance Improvements | PATCH |
40+
| `ci:` | CI/CD Changes | PATCH |
41+
| `build:` | Build System | PATCH |
42+
| `style:` | Styling Changes | PATCH |
43+
44+
### Breaking changes
45+
46+
Add `!` after the type to signal a breaking change (MAJOR version bump):
47+
48+
```text
49+
feat!: remove deprecated API
50+
```
51+
52+
### Release workflow
53+
54+
1. Merge a PR with a conventional title
55+
2. Release Please creates/updates a release PR with version bump and changelog
56+
3. Merge the release PR when ready to publish
57+
4. Release Please creates a GitHub release with a git tag

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md

0 commit comments

Comments
 (0)