@erclx/aitk 0.22.1 → 0.24.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-roadmap/references/roadmap.md +12 -2
- package/claude/skills/claude-standards-audit/SKILL.md +3 -3
- package/claude/skills/create-standard/references/snippets.md +9 -0
- package/claude/skills/git-branch/references/branch.md +12 -1
- package/claude/skills/git-commit/references/commit.md +11 -1
- package/claude/skills/git-issue/references/issue.md +10 -0
- package/claude/skills/git-pr/references/branch.md +12 -1
- package/claude/skills/git-pr/references/pr.md +12 -1
- package/claude/skills/git-split/references/branch.md +12 -1
- package/claude/skills/git-split/references/pr.md +12 -1
- package/claude/skills/git-stage/references/commit.md +11 -1
- package/docs/agents.md +10 -5
- package/package.json +1 -1
- package/src/commands/sandbox.ts +99 -5
- package/src/sandbox/census.ts +228 -0
- package/standards/architecture.md +10 -2
- package/standards/bundled/branch.md +12 -1
- package/standards/bundled/commit.md +11 -1
- package/standards/bundled/issue.md +10 -0
- package/standards/bundled/pr.md +12 -1
- package/standards/bundled/roadmap.md +12 -2
- package/standards/bundled/snippets.md +9 -0
- package/standards/context.md +11 -0
- package/standards/design.md +9 -1
- package/standards/diagrams.md +13 -2
- package/standards/prose.md +11 -0
- package/standards/readme.md +9 -0
- package/standards/requirements.md +10 -1
- package/standards/rule.md +10 -0
- package/standards/skill.md +11 -0
- package/standards/standard.md +24 -4
- package/standards/tasks.md +11 -0
- package/standards/versioning.md +11 -0
- package/standards/wireframes.md +11 -1
- package/claude/skills/claude-standards-audit/references/branch.md +0 -49
- package/claude/skills/claude-standards-audit/references/pr.md +0 -124
package/standards/wireframes.md
CHANGED
|
@@ -9,6 +9,16 @@ Applies to per-surface entries under `.claude/wireframes/`. Skip for `index.md`,
|
|
|
9
9
|
|
|
10
10
|
A wireframe file captures the spatial layout and interaction intent of one UI surface. It is not an implementation log. The check for any single line: would it still be true if the surface were rebuilt in a different framework? If not, it belongs in `.claude/context/`.
|
|
11
11
|
|
|
12
|
+
## Scope
|
|
13
|
+
|
|
14
|
+
Governs per-surface wireframe entries under `.claude/wireframes/`: layout, variants, on-screen copy, and interaction intent.
|
|
15
|
+
|
|
16
|
+
Does not govern:
|
|
17
|
+
|
|
18
|
+
- Tokens, typography, spacing, and the rest of the visual system: `design.md`
|
|
19
|
+
- The mechanism behind a surface: `context.md`
|
|
20
|
+
- Voice, punctuation, and formatting in wireframe prose: `prose.md`
|
|
21
|
+
|
|
12
22
|
## What a working wireframe looks like
|
|
13
23
|
|
|
14
24
|
A wireframe works when someone can rebuild the surface from it without opening the components:
|
|
@@ -64,4 +74,4 @@ Reference the context entry from the wireframe by path when a reader needs the m
|
|
|
64
74
|
## Maintenance
|
|
65
75
|
|
|
66
76
|
- When a surface's layout or interaction changes, update its wireframe file in the same PR. A wireframe showing a defunct layout is worse than none.
|
|
67
|
-
-
|
|
77
|
+
- The Behavior and Copy prose around an ASCII block is prose and follows `prose.md`. The fenced block itself is not, so a check scoped to prose is the wrong thing to rely on for what sits inside it.
|
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Branch reference
|
|
3
|
-
description: Branch naming format and type conventions
|
|
4
|
-
consumers: git-branch, git-split, git-pr, claude-standards-audit
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Branch reference
|
|
8
|
-
|
|
9
|
-
## Format
|
|
10
|
-
|
|
11
|
-
- Structure: `<type>/<description>` or `<type>/<ticket>-<description>`
|
|
12
|
-
- Length: 50 characters maximum
|
|
13
|
-
- Casing: kebab-case only, no underscores or camelCase
|
|
14
|
-
- Description: 2 words maximum, 3 only when genuinely needed for specificity
|
|
15
|
-
- Capture the core change, not the commit message verbatim
|
|
16
|
-
- For branches with multiple commits, use the unifying concern as the description.
|
|
17
|
-
- Do not duplicate type in description (e.g., `feat/feature-login`)
|
|
18
|
-
|
|
19
|
-
## Types
|
|
20
|
-
|
|
21
|
-
- `feat`: new feature or capability
|
|
22
|
-
- `fix`: bug fix
|
|
23
|
-
- `refactor`: structural changes (not a fix or feature)
|
|
24
|
-
- `docs`: documentation only (README)
|
|
25
|
-
- `chore`: maintenance tasks (deps, tooling, configs)
|
|
26
|
-
- `perf`: performance improvements
|
|
27
|
-
- `test`: add or modify tests
|
|
28
|
-
- `style`: code formatting (whitespace, semicolons)
|
|
29
|
-
- `build`: build system changes (webpack, npm scripts)
|
|
30
|
-
- `ci`: CI/CD pipeline changes (GitHub Actions)
|
|
31
|
-
- `revert`: revert a previous commit
|
|
32
|
-
|
|
33
|
-
## Examples
|
|
34
|
-
|
|
35
|
-
### Correct
|
|
36
|
-
|
|
37
|
-
```plaintext
|
|
38
|
-
feat/jwt-expiration # clear feature scope
|
|
39
|
-
fix/AUTH-123-connection-pool # includes ticket ID
|
|
40
|
-
refactor/remove-deprecated-endpoints # clear refactor intent
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
### Incorrect
|
|
44
|
-
|
|
45
|
-
```plaintext
|
|
46
|
-
feature/auth_stuff # wrong type + underscore
|
|
47
|
-
feat/feature-add-login # duplicates type in description
|
|
48
|
-
fix/DB-456-fix-the-database-connection-pool-memory-leak # exceeds 50 chars + verbatim message
|
|
49
|
-
```
|
|
@@ -1,124 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Pull request reference
|
|
3
|
-
description: Pull request title and body conventions
|
|
4
|
-
consumers: git-split, git-pr, claude-standards-audit
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Pull request reference
|
|
8
|
-
|
|
9
|
-
## Title
|
|
10
|
-
|
|
11
|
-
- Format: `<type>(<scope>): <subject>`
|
|
12
|
-
- Casing: lowercase for `<type>`, `<scope>`, and first word of `<subject>`
|
|
13
|
-
- Length: 72 characters maximum
|
|
14
|
-
|
|
15
|
-
## Content
|
|
16
|
-
|
|
17
|
-
- Use imperative mood for all content (`add`, `fix`, `refactor`)
|
|
18
|
-
- Do not start with "This PR," "This commit," "Included are," or "I have"
|
|
19
|
-
- Do not use buzzwords (`seamless`, `robust`, `game-changer`, `enhanced`)
|
|
20
|
-
- Do not describe historical behavior or unchanged code. Describe new behavior only.
|
|
21
|
-
- Do not include future promises or speculative documentation
|
|
22
|
-
- Do not explain obvious changes (formatting, renaming variables)
|
|
23
|
-
- Do not duplicate commit messages verbatim
|
|
24
|
-
|
|
25
|
-
## Sections
|
|
26
|
-
|
|
27
|
-
- `## Summary`: 1-2 sentences following `<Action Verb> <Direct Object> to <Result>`, expand for clarity if needed
|
|
28
|
-
- `## Key Changes`: name actual files, functions, or modules (e.g., `AuthService.verify()` not "auth handler"). Always use bullet points, never prose.
|
|
29
|
-
- `## Technical Context` (optional): 1-2 lines of architectural reasoning explaining why, not what
|
|
30
|
-
- Omit Technical Context for docs, config, or trivial changes
|
|
31
|
-
- Use bullet points for multiple reasons, one sentence for a single reason
|
|
32
|
-
- `## Testing` (optional): specify exact commands or test cases run
|
|
33
|
-
- Omit Testing for docs, config, or trivial sync changes
|
|
34
|
-
- Use checkboxes, never prose. See Testing discipline for which box gets ticked.
|
|
35
|
-
- `## For the reviewer` (optional): what the reviewer should confirm, one bullet per request
|
|
36
|
-
- Visuals: include only when they clarify architecture, UI, or complex logic flows
|
|
37
|
-
|
|
38
|
-
## Testing discipline
|
|
39
|
-
|
|
40
|
-
- Run the check before writing its line. A `- [ ]` reports a check that has not run rather than one that is planned.
|
|
41
|
-
- Tick the box and state the observed result. `- [x] npm test passes, 42 tests` beats `- [ ] run npm test`.
|
|
42
|
-
- Quote the count or output the run reported, never a figure carried from elsewhere.
|
|
43
|
-
- Leave a box unchecked only when a human is required, and name which human and why on the same line.
|
|
44
|
-
- Human-only covers visual or aesthetic judgment, anything needing credentials or a live third-party service, anything needing a second machine or a fresh OS, and judgment about whether a boundary or an abstraction reads correctly. The agent runs everything else.
|
|
45
|
-
- Put a request for the reviewer under `## For the reviewer`. It is a request rather than unfinished testing, so it never appears as an unchecked Testing box.
|
|
46
|
-
|
|
47
|
-
## Formatting
|
|
48
|
-
|
|
49
|
-
- End every bullet point with a period
|
|
50
|
-
|
|
51
|
-
## Examples
|
|
52
|
-
|
|
53
|
-
### Template
|
|
54
|
-
|
|
55
|
-
```markdown
|
|
56
|
-
## Summary
|
|
57
|
-
|
|
58
|
-
<Action Verb> <Direct Object> to <Result>.
|
|
59
|
-
|
|
60
|
-
## Key Changes
|
|
61
|
-
|
|
62
|
-
- <Verb> <specific component/file/function> (<reason if non-obvious>)
|
|
63
|
-
- <Verb> <specific component/file/function>
|
|
64
|
-
|
|
65
|
-
## Technical Context
|
|
66
|
-
|
|
67
|
-
- <Architectural reasoning explaining why, not what>
|
|
68
|
-
|
|
69
|
-
## Testing
|
|
70
|
-
|
|
71
|
-
- [x] <Command run> <observed result>
|
|
72
|
-
- [x] <Edge case verified> <what was observed>
|
|
73
|
-
- [ ] <Human-only check> (<which human, why>)
|
|
74
|
-
|
|
75
|
-
## For the reviewer
|
|
76
|
-
|
|
77
|
-
- <What the reviewer should confirm>
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
### Correct
|
|
81
|
-
|
|
82
|
-
```markdown
|
|
83
|
-
## Summary
|
|
84
|
-
|
|
85
|
-
Update auth middleware to enforce jwt expiration checks. # imperative + direct object + result
|
|
86
|
-
|
|
87
|
-
## Key Changes
|
|
88
|
-
|
|
89
|
-
- Add `verifyExpiration()` to `src/auth/validators.ts`. # specific function + file path
|
|
90
|
-
- Refactor `AuthService.authenticate()` to handle 401 codes. # named component + clear change
|
|
91
|
-
|
|
92
|
-
## Technical Context
|
|
93
|
-
|
|
94
|
-
- Migration to stateless session management for horizontal scalability. # why, not what
|
|
95
|
-
|
|
96
|
-
## Testing
|
|
97
|
-
|
|
98
|
-
- [x] `npm run test:auth` passes, 42 tests. # command run + observed result
|
|
99
|
-
- [x] Expired token rejected with a 401 against a local server. # edge case + what happened
|
|
100
|
-
- [ ] Staging smoke test (release owner, needs staging credentials). # unchecked + which human + why
|
|
101
|
-
|
|
102
|
-
## For the reviewer
|
|
103
|
-
|
|
104
|
-
- Confirm the 401 and 403 split reads correctly for the public API. # a request, not a test result
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
### Incorrect
|
|
108
|
-
|
|
109
|
-
```markdown
|
|
110
|
-
## Summary
|
|
111
|
-
|
|
112
|
-
This PR updates the authentication system to be more robust. # "This PR" opener + buzzword
|
|
113
|
-
|
|
114
|
-
## Key Changes
|
|
115
|
-
|
|
116
|
-
- Updated auth middleware files # vague, no specific component, no period
|
|
117
|
-
- The old system used to check tokens differently # describes historical behavior
|
|
118
|
-
|
|
119
|
-
## Testing
|
|
120
|
-
|
|
121
|
-
- Tested manually # no specific command or case
|
|
122
|
-
- [ ] `npm run test:auth` # unchecked box for a check the agent can run
|
|
123
|
-
- [ ] Reviewer confirms the error split reads correctly # a reviewer request, belongs under `## For the reviewer`
|
|
124
|
-
```
|