You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Codify commit, PR, and Linear linking rules for agents (#475)
Make CONTRIBUTING.md the source of truth so agents stop inventing
Conventional Commits prefixes, ticket IDs in subjects, and free-form
PR bodies. Point AGENTS.md and README at it; add a PR template.
Copy file name to clipboardExpand all lines: AGENTS.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,9 +49,13 @@ Run the full suite before declaring any task complete. Do not substitute individ
49
49
scans `vendor/`, adding hundreds of unrelated results and making pass/fail
50
50
counts meaningless to compare across branches — always use `bun run test`.
51
51
52
-
## Commits
52
+
## Commits, pull requests, and issue tracking
53
53
54
-
Follow the `style` skill's message format: plain-English summary, no `feat:`/`fix:` prefixes, no filename in the summary. Separate refactors from feature additions. Commit with the user's local git identity.
54
+
**MUST follow `CONTRIBUTING.md`.** That file is the source of truth for commit
55
+
titles and bodies, PR titles and bodies, and Linear/GitHub linking. Do not use
Thanks for contributing. This document covers setup, workflow, and legal requirements. Coding conventions live in `AGENTS.md` — read that before writing code.
3
+
Thanks for contributing. This document is the **source of truth** for commits,
4
+
pull requests, and issue tracking. Coding conventions live in `AGENTS.md` —
5
+
read that before writing code. Agents **must** follow the rules below; do not
6
+
substitute a personal or skill-only convention when this file conflicts.
Use non-closing words for partial work or multi-issue branches. Only issues
200
+
this PR fully completes get a closing word.
201
+
202
+
To deliberately **not** link an issue whose ID appears in the branch name:
203
+
204
+
```text
205
+
skip CL-1234
206
+
```
207
+
208
+
(or `ignore CL-1234`).
209
+
210
+
### When work tracks a GitHub issue only (MUST)
211
+
212
+
Same pattern in the PR body:
213
+
214
+
```text
215
+
Fixes #123
216
+
```
217
+
218
+
### When there is no tracker
219
+
220
+
Omit magic words. Do not invent issue IDs.
221
+
222
+
### After merge (SHOULD for agents running the full workflow)
223
+
224
+
1. Confirm the PR is merged and CI is green on the merge commit.
225
+
2. Comment the PR URL and merge SHA on the Linear issue.
226
+
3. Tick only description checkboxes that `main` actually completed.
227
+
4. Mark the Linear issue Done only when every outcome is truly done — never on
228
+
"PR opened" alone.
38
229
39
230
## Contributor License Agreement
40
231
41
-
All contributions require acceptance of the Contributor License Agreement in `CLA.md`. The CLA grants ABK Labs, Inc. rights needed to distribute contributions under the project license and alternative terms.
232
+
All contributions require acceptance of the Contributor License Agreement in
233
+
`CLA.md`. The CLA grants ABK Labs, Inc. rights needed to distribute
234
+
contributions under the project license and alternative terms.
42
235
43
-
CLA Assistant enforces this on pull requests (see `.github/workflows/cla.yml`). Sign once by posting a PR comment with exactly:
236
+
CLA Assistant enforces this on pull requests (see `.github/workflows/cla.yml`).
237
+
Sign once by posting a PR comment with exactly:
44
238
45
239
```text
46
240
I have read the CLA Document and I hereby sign the CLA
@@ -53,7 +247,10 @@ Signatures are stored on the `cla-signatures` branch and do not touch `main`.
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ After pulling new changes, re-run `bun run build:bin` to refresh the binary.
38
38
39
39
Before your first commit: `git config core.hooksPath .githooks` and `./bin/check-env`.
40
40
41
-
Every change must pass `bun run typecheck`, `bun run build`, and `bun test`, and behavior changes come with tests. Conventions live in `AGENTS.md` (functional TypeScript, no classes, arktype at boundaries, plain-English commit messages); the system design is documented in `docs/ARCHITECTURE.md` and `docs/IMPLEMENTATION.md`.
41
+
Every change must pass `bun run typecheck`, `bun run build`, and `bun run test`, and behavior changes come with tests. Coding conventions live in `AGENTS.md` (functional TypeScript, no classes, arktype at boundaries); commit, PR, and Linear/GitHub linking rules live in `CONTRIBUTING.md`. System design is documented in `docs/ARCHITECTURE.md` and `docs/IMPLEMENTATION.md`.
0 commit comments