Skip to content

Commit 58e99ef

Browse files
authored
fix(release): require conventional PR titles (#757)
* ci: require conventional PR titles * docs: document agent PR title convention
1 parent 0ffab59 commit 58e99ef

5 files changed

Lines changed: 54 additions & 6 deletions

File tree

.github/pull_request_template.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
-
44

5+
Title format: use Conventional Commits, for example
6+
`feat(compiler): add route graph output` or
7+
`fix(runtime): preserve clicked submit button`.
8+
59
## Issue Closure
610

711
<!-- Use Closes/Fixes/Resolves only when this PR fully resolves the issue.

.github/workflows/ci.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ on:
55
branches:
66
- main
77
pull_request:
8+
types:
9+
- opened
10+
- edited
11+
- reopened
12+
- synchronize
13+
- ready_for_review
814
workflow_dispatch:
915

1016
permissions:

.github/workflows/pr-title.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: PR title
2+
3+
on:
4+
pull_request_target:
5+
types:
6+
- opened
7+
- edited
8+
- reopened
9+
- synchronize
10+
- ready_for_review
11+
12+
permissions:
13+
contents: read
14+
15+
jobs:
16+
conventional-title:
17+
name: Conventional Commit title
18+
runs-on: ubuntu-latest
19+
20+
steps:
21+
- name: Check out base repository
22+
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
23+
with:
24+
ref: ${{ github.event.pull_request.base.sha }}
25+
26+
- name: Check pull request title
27+
env:
28+
PR_TITLE: ${{ github.event.pull_request.title }}
29+
run: scripts/check-pr-title.sh "$PR_TITLE"

AGENTS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,11 @@ If a future package adds a more specific validation command, document it in
130130

131131
- Treat `AGENTS.md` as the always-on project instruction file for every coding
132132
agent.
133+
- When committing or opening pull requests, use the repository Conventional
134+
Commit format for commit messages and PR titles, such as
135+
`ci: require conventional PR titles` or
136+
`fix(compiler): preserve route diagnostics`. Do not add generic agent
137+
prefixes such as `[codex]`; release-please parses the final PR/squash title.
133138
- Keep this file small by moving long process details into `.agents/skills/` and
134139
`.agents/templates/`.
135140
- If more specific rules are needed for a future subdirectory, add a nested

CONTRIBUTING.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,16 @@ reverse.
2828
## Workflow
2929

3030
1. Make the smallest vertical slice that exercises the behavior.
31-
2. Preserve unrelated user changes.
32-
3. Update tests, examples, docs, and status in the same change.
33-
4. Keep generated Go as adapter glue rather than application logic.
34-
5. Avoid new production dependencies unless the change documents the reason.
35-
6. Run focused checks first, then the relevant repository gates.
36-
7. Record commands that fail and the next action needed.
31+
2. Title pull requests with Conventional Commits, such as
32+
`feat(compiler): add route graph output` or
33+
`fix(runtime): preserve clicked submit button`; release-please uses the
34+
squash title for changelog and release-note generation.
35+
3. Preserve unrelated user changes.
36+
4. Update tests, examples, docs, and status in the same change.
37+
5. Keep generated Go as adapter glue rather than application logic.
38+
6. Avoid new production dependencies unless the change documents the reason.
39+
7. Run focused checks first, then the relevant repository gates.
40+
8. Record commands that fail and the next action needed.
3741

3842
## Verification
3943

0 commit comments

Comments
 (0)