@erclx/aitk 3.9.0 → 3.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/claude/.claude-plugin/plugin.json +1 -1
- package/claude/skills/claude-markdown-propose/REQUIREMENT.md +48 -0
- package/claude/skills/claude-markdown-propose/SKILL.md +118 -0
- package/claude/skills/claude-markdown-propose/references/format.md +107 -0
- package/claude/skills/claude-pr-review/SKILL.md +1 -1
- package/claude/skills/claude-teach/SKILL.md +1 -1
- package/claude/skills/claude-worktree/SKILL.md +1 -1
- package/claude/skills/create-snippet/SKILL.md +1 -1
- package/claude/skills/git-branch/SKILL.md +1 -1
- package/claude/skills/git-commit/SKILL.md +1 -1
- package/claude/skills/git-issue/SKILL.md +2 -2
- package/claude/skills/git-pr/SKILL.md +5 -5
- package/claude/skills/git-split/SKILL.md +2 -2
- package/claude/skills/git-stage/SKILL.md +1 -1
- package/claude/skills/toolkit-cli/SKILL.md +0 -2
- package/docs/agents/audits.md +4 -4
- package/docs/agents/census.md +23 -0
- package/docs/agents/commands.md +1 -0
- package/docs/agents/index.md +1 -0
- package/docs/agents/records.md +1 -1
- package/docs/agents/teach.md +1 -1
- package/docs/ai-workflow.md +7 -6
- package/package.json +1 -1
- package/scripts/core/check-skill-paths.sh +1 -2
- package/scripts/core/verify.sh +0 -5
- package/src/audits/catalog.ts +48 -0
- package/src/census/count.ts +113 -0
- package/src/claude/skills-audit.ts +7 -0
- package/src/cli.ts +4 -0
- package/src/commands/census.ts +105 -0
- package/src/commands/claude.ts +20 -6
- package/src/commands/comments.ts +6 -0
- package/src/commands/context.ts +32 -7
- package/src/commands/gov.ts +2 -2
- package/src/commands/markdown.ts +18 -2
- package/src/context/audit.ts +16 -0
- package/src/gov/test-order.ts +31 -7
- package/src/markdown/files.ts +10 -0
- package/src/records/backup.ts +1 -0
- package/src/records/validate.ts +1 -3
- package/{claude/skills/git-split/references → standards}/branch.md +0 -1
- package/{claude/skills/git-commit/references → standards}/commit.md +0 -1
- package/{claude/skills/claude-teach/references → standards}/glossary.md +0 -1
- package/standards/index.md +6 -0
- package/standards/{bundled/issue.md → issue.md} +0 -1
- package/standards/{bundled/pr.md → pr.md} +0 -1
- package/standards/{bundled/snippets.md → snippets.md} +0 -1
- package/tooling/base/manifest.toml +0 -2
- package/tooling/base/reference.md +12 -12
- package/tooling/base/seeds/.claude/context/development.md +4 -6
- package/claude/skills/claude-worktree/references/branch.md +0 -60
- package/claude/skills/create-snippet/references/snippets.md +0 -78
- package/claude/skills/git-branch/references/branch.md +0 -60
- package/claude/skills/git-issue/references/issue.md +0 -95
- package/claude/skills/git-pr/references/branch.md +0 -60
- package/claude/skills/git-pr/references/pr.md +0 -139
- package/claude/skills/git-split/references/pr.md +0 -139
- package/claude/skills/git-stage/references/commit.md +0 -73
- package/scripts/core/regen-skill-references.sh +0 -27
- package/standards/bundled/branch.md +0 -60
- package/standards/bundled/commit.md +0 -73
- package/standards/bundled/glossary.md +0 -76
- package/tooling/base/configs/scripts/clean.sh +0 -45
- package/tooling/base/configs/scripts/update.sh +0 -49
package/src/markdown/files.ts
CHANGED
|
@@ -19,6 +19,16 @@ export type FileScope =
|
|
|
19
19
|
}
|
|
20
20
|
| { readonly kind: 'unavailable' }
|
|
21
21
|
|
|
22
|
+
/**
|
|
23
|
+
* Every reason `aitk markdown audit` refuses for.
|
|
24
|
+
*
|
|
25
|
+
* None is an ordinary absence. `no-git` is a broken checkout the way it is
|
|
26
|
+
* for the secret scan, and a tree tracked by git carrying no markdown file at
|
|
27
|
+
* all, or an argument matching none, is a corpus this run could not build
|
|
28
|
+
* rather than a target that adopted none of the convention this check reads.
|
|
29
|
+
*/
|
|
30
|
+
export type MarkdownAuditRefusal = 'no-git' | 'no-markdown' | 'no-match'
|
|
31
|
+
|
|
22
32
|
function isDirectory(path: string): boolean {
|
|
23
33
|
try {
|
|
24
34
|
return statSync(path).isDirectory()
|
package/src/records/backup.ts
CHANGED
package/src/records/validate.ts
CHANGED
|
@@ -1115,9 +1115,7 @@ export async function validateRecords(
|
|
|
1115
1115
|
)
|
|
1116
1116
|
}
|
|
1117
1117
|
|
|
1118
|
-
// The walk stays flat, matching install and the catalog.
|
|
1119
|
-
// is a subfolder whose members are named for the skill that reads them rather
|
|
1120
|
-
// than for a path they govern, so the derivation below reports every one.
|
|
1118
|
+
// The walk stays flat, matching install and the catalog.
|
|
1121
1119
|
if (kind === 'standards') {
|
|
1122
1120
|
return validateFiles(
|
|
1123
1121
|
dir,
|
package/standards/index.md
CHANGED
|
@@ -8,14 +8,19 @@ subtitle: Reference docs for consistent authoring across the toolkit and target
|
|
|
8
8
|
Reference docs for consistent authoring across the toolkit and target projects.
|
|
9
9
|
|
|
10
10
|
- [Architecture reference](architecture.md): Shape and content rules for .claude/ARCHITECTURE.md
|
|
11
|
+
- [Branch reference](branch.md): Branch naming format and type conventions
|
|
12
|
+
- [Commit reference](commit.md): Commit message format and type conventions
|
|
11
13
|
- [Context entry reference](context.md): Shape and content rules for .claude/context/<domain>.md entries
|
|
12
14
|
- [Design reference](design.md): Shape and content rules for .claude/DESIGN.md
|
|
13
15
|
- [Diagram reference](diagrams.md): Shape and content rules for .claude/diagrams/<kind>.md files
|
|
16
|
+
- [Glossary reference](glossary.md): Frontmatter, entry shape, ordering, and the rules deciding which terms a glossary carries
|
|
14
17
|
- [Groundwork reference](groundwork.md): Folder layout, reserved numbering, frontmatter and dating, required file contents, and conventions for a measurement track
|
|
15
18
|
- [Intake reference](intake.md): Folder layout, reserved index number, frontmatter and dating, the item template, the answer contract, and retrieval
|
|
19
|
+
- [Issue reference](issue.md): GitHub issue title, labels, and body conventions
|
|
16
20
|
- [Markdown reference](markdown.md): Headings, paragraph and list structure, code spans, the date form, punctuation, emphasis, file references, banned words, and frontmatter wording
|
|
17
21
|
- [Memory reference](memory.md): Filename and type prefix, frontmatter, the body shape per type, links between entries, and the lifecycle from write to retire
|
|
18
22
|
- [Plan reference](plan.md): Filename and slug, required sections, the suggested-and-answer contract, and the lifecycle from the live folder to the archive
|
|
23
|
+
- [Pull request reference](pr.md): Pull request title and body conventions
|
|
19
24
|
- [Publish reference](publish.md): Scan an author runs against finished text, the cross-reference form each destination takes, and the response to an unreadable source
|
|
20
25
|
- [Readme reference](readme.md): Readme voice, structure, and content conventions
|
|
21
26
|
- [Requirements reference](requirements.md): Shape and content rules for .claude/REQUIREMENTS.md
|
|
@@ -23,6 +28,7 @@ Reference docs for consistent authoring across the toolkit and target projects.
|
|
|
23
28
|
- [Session map reference](session.md): Filename and location, the sections a handoff carries, the write and read procedures, and how a role extends it
|
|
24
29
|
- [Claude skill reference](skill.md): Claude skill structure and authoring rules
|
|
25
30
|
- [Slug reference](slug.md): Transform from a git branch name to a slug, and the three responses to an empty result
|
|
31
|
+
- [Snippet reference](snippets.md): Snippet reference and authoring conventions
|
|
26
32
|
- [Standard reference](standard.md): Shape and content rules for authoring a standard
|
|
27
33
|
- [Tasks reference](tasks.md): Folder layout, filename convention, readiness groups, and content rules for .claude/tasks/
|
|
28
34
|
- [Teach reference](teach.md): Workspace layout, ordinal naming, frontmatter, and the mission and learning-record formats for a learning workspace
|
|
@@ -23,8 +23,6 @@ packages = [
|
|
|
23
23
|
"format" = "prettier --write --log-level warn --ignore-path .gitignore --ignore-path .prettierignore . && shfmt --write --indent 2 scripts/"
|
|
24
24
|
"prepare" = "husky"
|
|
25
25
|
"check" = "./scripts/verify.sh"
|
|
26
|
-
"clean" = "./scripts/clean.sh"
|
|
27
|
-
"update" = "./scripts/update.sh"
|
|
28
26
|
|
|
29
27
|
[gitignore]
|
|
30
28
|
"# System" = [".DS_Store"]
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## Overview
|
|
4
4
|
|
|
5
|
-
The base layer covers every project the toolkit scaffolds, whatever language sits on top. It ships formatting, spelling, shell linting, conventional commits, git hooks, CI, and
|
|
5
|
+
The base layer covers every project the toolkit scaffolds, whatever language sits on top. It ships formatting, spelling, shell linting, conventional commits, git hooks, CI, and one maintenance script. Every other stack extends it, so a decision made here is one every stack inherits.
|
|
6
6
|
|
|
7
7
|
A repository with several language roots layers this stack once at the root and skips it per subtree, since git honors only one `core.hooksPath` and a re-dropped husky silently breaks. `docs/target-projects.md` carries the recipe.
|
|
8
8
|
|
|
@@ -18,7 +18,7 @@ Golden config files live in `tooling/base/configs/` and are copied into the targ
|
|
|
18
18
|
- `.github/workflows/verify.yml`: runs on pull requests targeting `main` and on `workflow_dispatch`.
|
|
19
19
|
- `.github/pull_request_template.md`: `## Summary`, `## Key Changes`, `## Technical Context`, `## Testing`.
|
|
20
20
|
- `.vscode/extensions.json` and `.vscode/settings.json`: editor wiring for Prettier, cspell, shfmt, and shellcheck.
|
|
21
|
-
- `scripts/verify.sh
|
|
21
|
+
- `scripts/verify.sh`: the maintenance entry point behind `check`.
|
|
22
22
|
|
|
23
23
|
## What ships as user-owned seeds
|
|
24
24
|
|
|
@@ -86,13 +86,13 @@ Sticky negative knowledge. Do not relearn.
|
|
|
86
86
|
|
|
87
87
|
## CLI
|
|
88
88
|
|
|
89
|
-
| Script | What it does
|
|
90
|
-
| ---------------------- |
|
|
91
|
-
| `bun run check` |
|
|
92
|
-
| `bun run check:format` | Asserts prettier and shfmt formatting without writing
|
|
93
|
-
| `bun run check:spell` | Runs cspell across every file, with context on failures
|
|
94
|
-
| `bun run check:shell` | Runs shellcheck at warning severity
|
|
95
|
-
| `bun run format` | Writes prettier and shfmt formatting in place
|
|
96
|
-
| `bun run prepare` | Initializes husky hooks, run automatically on `bun install`
|
|
97
|
-
|
|
98
|
-
|
|
89
|
+
| Script | What it does |
|
|
90
|
+
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
|
|
91
|
+
| `bun run check` | Repairs a checkout via `scripts/verify.sh`. Honors `VERIFY_NESTED=true` to suppress timeline boundaries when another script calls it. |
|
|
92
|
+
| `bun run check:format` | Asserts prettier and shfmt formatting without writing |
|
|
93
|
+
| `bun run check:spell` | Runs cspell across every file, with context on failures |
|
|
94
|
+
| `bun run check:shell` | Runs shellcheck at warning severity |
|
|
95
|
+
| `bun run format` | Writes prettier and shfmt formatting in place |
|
|
96
|
+
| `bun run prepare` | Initializes husky hooks, run automatically on `bun install` |
|
|
97
|
+
|
|
98
|
+
`bun run check` repairs a checkout rather than gating one. It runs `format` first to auto-fix drifted code, then asserts only what the formatters could not fix. The pull request workflow calls `check:format`, `check:spell`, and `check:shell` directly, and those three are the gate.
|
|
@@ -21,12 +21,10 @@ Owns how the project runs on a developer machine: installing the toolchain, the
|
|
|
21
21
|
|
|
22
22
|
## Scripts
|
|
23
23
|
|
|
24
|
-
| Command | Purpose
|
|
25
|
-
| ---------------- |
|
|
26
|
-
| `bun run check` |
|
|
27
|
-
| `bun run format` | Auto-fix prettier and shfmt formatting.
|
|
28
|
-
| `bun run clean` | Wipe `node_modules/`, clear bun cache, reinstall. |
|
|
29
|
-
| `bun run update` | Interactive `bun update` followed by verification. |
|
|
24
|
+
| Command | Purpose |
|
|
25
|
+
| ---------------- | ------------------------------------------------------------------------------ |
|
|
26
|
+
| `bun run check` | Repairs locally. Auto-formats, then asserts what the formatters could not fix. |
|
|
27
|
+
| `bun run format` | Auto-fix prettier and shfmt formatting. |
|
|
30
28
|
|
|
31
29
|
## Shell scripts
|
|
32
30
|
|
|
@@ -1,60 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Branch reference
|
|
3
|
-
description: Branch naming format and type conventions
|
|
4
|
-
consumers: git-branch, git-split, git-pr, claude-worktree
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Branch reference
|
|
8
|
-
|
|
9
|
-
## Scope
|
|
10
|
-
|
|
11
|
-
Governs a git branch name: its structure, its length, and the type vocabulary it draws from.
|
|
12
|
-
|
|
13
|
-
Does not govern:
|
|
14
|
-
|
|
15
|
-
- Commit subject format, which shares the type vocabulary: `commit.md`
|
|
16
|
-
- Pull request title and body: `pr.md`
|
|
17
|
-
- Whether a phase label may appear in a branch name: `versioning.md`
|
|
18
|
-
- Deriving a slug from a branch name for use in an output filename: `slug.md`
|
|
19
|
-
|
|
20
|
-
## Format
|
|
21
|
-
|
|
22
|
-
- Structure: `<type>/<description>` or `<type>/<ticket>-<description>`
|
|
23
|
-
- Length: 50 characters maximum
|
|
24
|
-
- Casing: kebab-case only, no underscores or camelCase
|
|
25
|
-
- Description: 2 words maximum, 3 only when genuinely needed for specificity
|
|
26
|
-
- Capture the core change, not the commit message verbatim
|
|
27
|
-
- For branches with multiple commits, use the unifying concern as the description.
|
|
28
|
-
- Do not duplicate type in description (e.g., `feat/feature-login`)
|
|
29
|
-
|
|
30
|
-
## Types
|
|
31
|
-
|
|
32
|
-
- `feat`: new feature or capability
|
|
33
|
-
- `fix`: bug fix
|
|
34
|
-
- `refactor`: structural changes (not a fix or feature)
|
|
35
|
-
- `docs`: documentation only (README)
|
|
36
|
-
- `chore`: maintenance tasks (deps, tooling, configs)
|
|
37
|
-
- `perf`: performance improvements
|
|
38
|
-
- `test`: add or modify tests
|
|
39
|
-
- `style`: code formatting (whitespace, semicolons)
|
|
40
|
-
- `build`: build system changes (webpack, npm scripts)
|
|
41
|
-
- `ci`: CI/CD pipeline changes (GitHub Actions)
|
|
42
|
-
- `revert`: revert a previous commit
|
|
43
|
-
|
|
44
|
-
## Examples
|
|
45
|
-
|
|
46
|
-
### Correct
|
|
47
|
-
|
|
48
|
-
```plaintext
|
|
49
|
-
feat/jwt-expiration # clear feature scope
|
|
50
|
-
fix/AUTH-123-connection-pool # includes ticket ID
|
|
51
|
-
refactor/remove-deprecated-endpoints # clear refactor intent
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
### Incorrect
|
|
55
|
-
|
|
56
|
-
```plaintext
|
|
57
|
-
feature/auth_stuff # wrong type + underscore
|
|
58
|
-
feat/feature-add-login # duplicates type in description
|
|
59
|
-
fix/DB-456-fix-the-database-connection-pool-memory-leak # exceeds 50 chars + verbatim message
|
|
60
|
-
```
|
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Snippet reference
|
|
3
|
-
description: Snippet reference and authoring conventions
|
|
4
|
-
consumers: create-snippet
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Snippet reference
|
|
8
|
-
|
|
9
|
-
## Scope
|
|
10
|
-
|
|
11
|
-
Governs a snippet file: what one is for, whether a prompt qualifies as one, how it is invoked, and the structure of its body.
|
|
12
|
-
|
|
13
|
-
Does not govern:
|
|
14
|
-
|
|
15
|
-
- Skill folders, which carry frontmatter, references, and scripts a snippet has none of: `skill.md`
|
|
16
|
-
- Voice, rhythm, and sentence construction in snippet prose: the `write-human` skill
|
|
17
|
-
- Punctuation, formatting, and word choice in snippet prose: `markdown.md`
|
|
18
|
-
|
|
19
|
-
## What a snippet is
|
|
20
|
-
|
|
21
|
-
A snippet is a short, focused prompt stored as a plain markdown file. Invoke one to insert a prepared instruction into any AI chat without retyping it. Each snippet covers one purpose. If a prompt needs headers or multiple goals, use a system prompt instead.
|
|
22
|
-
|
|
23
|
-
## Admission
|
|
24
|
-
|
|
25
|
-
Two tests decide whether a prompt becomes a snippet, and both have to pass. Apply them when adding one and when auditing the catalog.
|
|
26
|
-
|
|
27
|
-
- Cadence: a prompt invoked many times across sessions qualifies. A one-shot audit, migration, or bootstrap prompt does not, and belongs in notes outside the catalog.
|
|
28
|
-
- Audience: a prompt the consuming project would invoke ships in `snippets/`. One only the authoring repository can run stays outside every installable folder, which is a rule for a repository that authors snippets for others rather than for one that only consumes them.
|
|
29
|
-
|
|
30
|
-
A subfolder under `snippets/` names where a prompt is invoked rather than what it is about. A prompt that reads or writes the project's own files goes in a folder, and one carrying its whole context in the message goes at the root.
|
|
31
|
-
|
|
32
|
-
Overlapping a skill that does the same job is not disqualifying on its own. A snippet fires when a person asks for it by name and a skill fires on a description match, so the two coexist when those paths differ and the outputs do. Record the reason where the project keeps its decisions, or drop the snippet.
|
|
33
|
-
|
|
34
|
-
## Invocation channels
|
|
35
|
-
|
|
36
|
-
- Chrome extension: type `>slug` in a supported chat UI (claude.ai, gemini.google.com) to insert the snippet text inline
|
|
37
|
-
- Claude Code terminal: prefix the install path with `@` (e.g. `@.claude/snippets/claude/feature`)
|
|
38
|
-
- Snippets install preserving the source folder structure. A snippet at `claude/edit.md` installs as `.claude/snippets/claude/edit.md` and is invoked as `@.claude/snippets/claude/edit`
|
|
39
|
-
|
|
40
|
-
## Use patterns
|
|
41
|
-
|
|
42
|
-
- Run-as-is: invoke and send immediately. The snippet is self-contained and needs no extra context.
|
|
43
|
-
- Invoke-then-add-context: invoke the snippet, then append specifics in the same message (e.g. invoke `claude-feature`, then add the feature name or extra constraints)
|
|
44
|
-
- Invoke-on-history: invoke after a discussion. The snippet uses prior conversation as implicit context with no additional input needed (e.g. invoke `claude-figma` after discussing a design).
|
|
45
|
-
|
|
46
|
-
## Authoring
|
|
47
|
-
|
|
48
|
-
- One focused purpose per snippet. If it needs headers or multiple goals, use a system prompt instead.
|
|
49
|
-
- Self-contained. No references to external files or assumed prior context.
|
|
50
|
-
- No user fill-in placeholders. If a value depends on context, the user adds it after invocation.
|
|
51
|
-
- Plain markdown only. No YAML frontmatter, no headers, no nested structure.
|
|
52
|
-
- Filename is the slug: kebab-case, no capitals, no underscores
|
|
53
|
-
|
|
54
|
-
## Structure
|
|
55
|
-
|
|
56
|
-
- Lead with a verb. Open with an imperative that states the job immediately.
|
|
57
|
-
- One instruction per sentence. Do not stack multiple actions into one sentence.
|
|
58
|
-
- For sequential steps, use a numbered list with one action per item.
|
|
59
|
-
- When the output has a fixed shape, show it in a fenced code block with a language identifier.
|
|
60
|
-
- Put constraints and exclusions last, not inline with the main instructions.
|
|
61
|
-
|
|
62
|
-
## Examples
|
|
63
|
-
|
|
64
|
-
### Correct
|
|
65
|
-
|
|
66
|
-
```markdown
|
|
67
|
-
I want to implement the following. Scan relevant files and list conflicts. Do not implement. # user adds feature after invocation
|
|
68
|
-
Scan relevant files and list conflicts. Do not implement. # run-as-is, no context needed
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
### Incorrect
|
|
72
|
-
|
|
73
|
-
```markdown
|
|
74
|
-
I want to implement: <feature or task name> # redundant fill-in, add context after invocation instead
|
|
75
|
-
See ARCHITECTURE.md before starting. # external dependency, not self-contained
|
|
76
|
-
|
|
77
|
-
## Overview\n## Steps # headers belong in a system prompt, not a snippet
|
|
78
|
-
```
|
|
@@ -1,60 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Branch reference
|
|
3
|
-
description: Branch naming format and type conventions
|
|
4
|
-
consumers: git-branch, git-split, git-pr, claude-worktree
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Branch reference
|
|
8
|
-
|
|
9
|
-
## Scope
|
|
10
|
-
|
|
11
|
-
Governs a git branch name: its structure, its length, and the type vocabulary it draws from.
|
|
12
|
-
|
|
13
|
-
Does not govern:
|
|
14
|
-
|
|
15
|
-
- Commit subject format, which shares the type vocabulary: `commit.md`
|
|
16
|
-
- Pull request title and body: `pr.md`
|
|
17
|
-
- Whether a phase label may appear in a branch name: `versioning.md`
|
|
18
|
-
- Deriving a slug from a branch name for use in an output filename: `slug.md`
|
|
19
|
-
|
|
20
|
-
## Format
|
|
21
|
-
|
|
22
|
-
- Structure: `<type>/<description>` or `<type>/<ticket>-<description>`
|
|
23
|
-
- Length: 50 characters maximum
|
|
24
|
-
- Casing: kebab-case only, no underscores or camelCase
|
|
25
|
-
- Description: 2 words maximum, 3 only when genuinely needed for specificity
|
|
26
|
-
- Capture the core change, not the commit message verbatim
|
|
27
|
-
- For branches with multiple commits, use the unifying concern as the description.
|
|
28
|
-
- Do not duplicate type in description (e.g., `feat/feature-login`)
|
|
29
|
-
|
|
30
|
-
## Types
|
|
31
|
-
|
|
32
|
-
- `feat`: new feature or capability
|
|
33
|
-
- `fix`: bug fix
|
|
34
|
-
- `refactor`: structural changes (not a fix or feature)
|
|
35
|
-
- `docs`: documentation only (README)
|
|
36
|
-
- `chore`: maintenance tasks (deps, tooling, configs)
|
|
37
|
-
- `perf`: performance improvements
|
|
38
|
-
- `test`: add or modify tests
|
|
39
|
-
- `style`: code formatting (whitespace, semicolons)
|
|
40
|
-
- `build`: build system changes (webpack, npm scripts)
|
|
41
|
-
- `ci`: CI/CD pipeline changes (GitHub Actions)
|
|
42
|
-
- `revert`: revert a previous commit
|
|
43
|
-
|
|
44
|
-
## Examples
|
|
45
|
-
|
|
46
|
-
### Correct
|
|
47
|
-
|
|
48
|
-
```plaintext
|
|
49
|
-
feat/jwt-expiration # clear feature scope
|
|
50
|
-
fix/AUTH-123-connection-pool # includes ticket ID
|
|
51
|
-
refactor/remove-deprecated-endpoints # clear refactor intent
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
### Incorrect
|
|
55
|
-
|
|
56
|
-
```plaintext
|
|
57
|
-
feature/auth_stuff # wrong type + underscore
|
|
58
|
-
feat/feature-add-login # duplicates type in description
|
|
59
|
-
fix/DB-456-fix-the-database-connection-pool-memory-leak # exceeds 50 chars + verbatim message
|
|
60
|
-
```
|
|
@@ -1,95 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Issue reference
|
|
3
|
-
description: GitHub issue title, labels, and body conventions
|
|
4
|
-
consumers: git-issue
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Issue reference
|
|
8
|
-
|
|
9
|
-
## Scope
|
|
10
|
-
|
|
11
|
-
Governs a tracker issue: its title, its labels, and the sections its body carries.
|
|
12
|
-
|
|
13
|
-
Does not govern:
|
|
14
|
-
|
|
15
|
-
- Pull request title and body: `pr.md`
|
|
16
|
-
- Whether a phase label may appear in issue text: `versioning.md`
|
|
17
|
-
- Voice, rhythm, and sentence construction in issue prose: the `write-human` skill
|
|
18
|
-
- Punctuation, formatting, and banned words in issue prose: `markdown.md`
|
|
19
|
-
|
|
20
|
-
## Title
|
|
21
|
-
|
|
22
|
-
- Format: `<type>: <subject>`
|
|
23
|
-
- Type is `bug` or `task`. Lowercase the type and the first word of the subject.
|
|
24
|
-
- Length: 72 characters maximum, no trailing period.
|
|
25
|
-
|
|
26
|
-
## Labels
|
|
27
|
-
|
|
28
|
-
- Apply `bug` for a defect and `enhancement` for a task or improvement.
|
|
29
|
-
- Both are GitHub default labels. A label that does not exist makes `gh` reject the issue. Create it once with `gh label create`.
|
|
30
|
-
- One label per issue unless a second genuinely applies.
|
|
31
|
-
|
|
32
|
-
## Content
|
|
33
|
-
|
|
34
|
-
- Use imperative mood and describe the actual defect or work, not that something is wrong.
|
|
35
|
-
- Do not open with "This issue," "I want," or "We should."
|
|
36
|
-
- Do not use buzzwords or speculative future scope.
|
|
37
|
-
- State observable behavior for a bug, not a guessed cause.
|
|
38
|
-
|
|
39
|
-
## Sections
|
|
40
|
-
|
|
41
|
-
- `## Summary`: one line naming what and why.
|
|
42
|
-
- `## Details`: for a bug, what happens versus what is expected. For a task, what to build.
|
|
43
|
-
- `## Context`: for a bug, repro steps or commands. For a task, the driving reason, or `none`.
|
|
44
|
-
- `## Proposed` (optional): one line naming a fix or approach. Omit when open.
|
|
45
|
-
|
|
46
|
-
## Formatting
|
|
47
|
-
|
|
48
|
-
- End every bullet with a period.
|
|
49
|
-
- Keep each section to one or two lines.
|
|
50
|
-
|
|
51
|
-
## Examples
|
|
52
|
-
|
|
53
|
-
### Correct (bug)
|
|
54
|
-
|
|
55
|
-
```markdown
|
|
56
|
-
## Summary
|
|
57
|
-
|
|
58
|
-
Fix the feedback CLI so it applies the `feedback` label.
|
|
59
|
-
|
|
60
|
-
## Details
|
|
61
|
-
|
|
62
|
-
`aitk feedback --github` opens an issue with no label, so `toolkit-triage` never lists it.
|
|
63
|
-
|
|
64
|
-
## Context
|
|
65
|
-
|
|
66
|
-
Run a piped `aitk feedback --github`, then check the issue carries no `feedback` label.
|
|
67
|
-
|
|
68
|
-
## Proposed
|
|
69
|
-
|
|
70
|
-
Pass `--label feedback` through the shared issue helper.
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
### Correct (task)
|
|
74
|
-
|
|
75
|
-
```markdown
|
|
76
|
-
## Summary
|
|
77
|
-
|
|
78
|
-
Add a git-issue skill so a session can file an issue on the current repo.
|
|
79
|
-
|
|
80
|
-
## Details
|
|
81
|
-
|
|
82
|
-
Format an issue from session context and file it with `gh issue create`, next to git-pr in the git family.
|
|
83
|
-
|
|
84
|
-
## Context
|
|
85
|
-
|
|
86
|
-
The toolkit-issue skill only files on the toolkit repo. A general path is needed for target projects.
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
### Incorrect
|
|
90
|
-
|
|
91
|
-
```markdown
|
|
92
|
-
## Summary
|
|
93
|
-
|
|
94
|
-
This issue is about the feedback system being kind of broken, and we should probably make it more robust.
|
|
95
|
-
```
|
|
@@ -1,60 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Branch reference
|
|
3
|
-
description: Branch naming format and type conventions
|
|
4
|
-
consumers: git-branch, git-split, git-pr, claude-worktree
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Branch reference
|
|
8
|
-
|
|
9
|
-
## Scope
|
|
10
|
-
|
|
11
|
-
Governs a git branch name: its structure, its length, and the type vocabulary it draws from.
|
|
12
|
-
|
|
13
|
-
Does not govern:
|
|
14
|
-
|
|
15
|
-
- Commit subject format, which shares the type vocabulary: `commit.md`
|
|
16
|
-
- Pull request title and body: `pr.md`
|
|
17
|
-
- Whether a phase label may appear in a branch name: `versioning.md`
|
|
18
|
-
- Deriving a slug from a branch name for use in an output filename: `slug.md`
|
|
19
|
-
|
|
20
|
-
## Format
|
|
21
|
-
|
|
22
|
-
- Structure: `<type>/<description>` or `<type>/<ticket>-<description>`
|
|
23
|
-
- Length: 50 characters maximum
|
|
24
|
-
- Casing: kebab-case only, no underscores or camelCase
|
|
25
|
-
- Description: 2 words maximum, 3 only when genuinely needed for specificity
|
|
26
|
-
- Capture the core change, not the commit message verbatim
|
|
27
|
-
- For branches with multiple commits, use the unifying concern as the description.
|
|
28
|
-
- Do not duplicate type in description (e.g., `feat/feature-login`)
|
|
29
|
-
|
|
30
|
-
## Types
|
|
31
|
-
|
|
32
|
-
- `feat`: new feature or capability
|
|
33
|
-
- `fix`: bug fix
|
|
34
|
-
- `refactor`: structural changes (not a fix or feature)
|
|
35
|
-
- `docs`: documentation only (README)
|
|
36
|
-
- `chore`: maintenance tasks (deps, tooling, configs)
|
|
37
|
-
- `perf`: performance improvements
|
|
38
|
-
- `test`: add or modify tests
|
|
39
|
-
- `style`: code formatting (whitespace, semicolons)
|
|
40
|
-
- `build`: build system changes (webpack, npm scripts)
|
|
41
|
-
- `ci`: CI/CD pipeline changes (GitHub Actions)
|
|
42
|
-
- `revert`: revert a previous commit
|
|
43
|
-
|
|
44
|
-
## Examples
|
|
45
|
-
|
|
46
|
-
### Correct
|
|
47
|
-
|
|
48
|
-
```plaintext
|
|
49
|
-
feat/jwt-expiration # clear feature scope
|
|
50
|
-
fix/AUTH-123-connection-pool # includes ticket ID
|
|
51
|
-
refactor/remove-deprecated-endpoints # clear refactor intent
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
### Incorrect
|
|
55
|
-
|
|
56
|
-
```plaintext
|
|
57
|
-
feature/auth_stuff # wrong type + underscore
|
|
58
|
-
feat/feature-add-login # duplicates type in description
|
|
59
|
-
fix/DB-456-fix-the-database-connection-pool-memory-leak # exceeds 50 chars + verbatim message
|
|
60
|
-
```
|