@erclx/aitk 0.84.0 → 0.85.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/governance/rules/claude/520-wireframes.md +9 -1
- package/governance/rules/claude/530-requirements.md +8 -0
- package/governance/rules/claude/540-architecture.md +10 -0
- package/governance/rules/claude/550-design.md +8 -0
- package/governance/rules/claude/555-tasks.md +8 -0
- package/governance/rules/claude/580-readme.md +8 -0
- package/governance/rules/claude/590-rule-authoring.md +11 -0
- package/governance/rules/claude/591-standard-authoring.md +8 -0
- package/package.json +1 -1
|
@@ -6,7 +6,15 @@ paths:
|
|
|
6
6
|
|
|
7
7
|
# Wireframe standards
|
|
8
8
|
|
|
9
|
+
## Layout and intent
|
|
10
|
+
|
|
11
|
+
- Draw each surface as an ASCII block inside a `plaintext` fence, one fence per distinct layout.
|
|
12
|
+
- Label a region with its role. Never label one with a class name, a token name, or a computed value.
|
|
13
|
+
- Carry on-screen copy verbatim, and mark copy the surface templates.
|
|
14
|
+
- State interaction intent, never the mechanism behind it. Send algorithms, handlers, and thresholds to a `.claude/context/` entry.
|
|
15
|
+
- Update a surface's wireframe in the same pull request that changes its layout or its interaction.
|
|
16
|
+
|
|
9
17
|
## Authority
|
|
10
18
|
|
|
11
19
|
- Follow `.claude/standards/wireframes.md` for layout and interaction intent: ASCII layout, region labels, variants, copy, and what moves to `.claude/context/`. It is the single source.
|
|
12
|
-
-
|
|
20
|
+
- Read it before adding or revising a surface.
|
|
@@ -6,6 +6,14 @@ paths:
|
|
|
6
6
|
|
|
7
7
|
# Requirements standards
|
|
8
8
|
|
|
9
|
+
## Scope and non-goals
|
|
10
|
+
|
|
11
|
+
- State a goal as a user-facing outcome, never as the implementation delivering it.
|
|
12
|
+
- Record explicit non-goals. Mark a deferred item `(deferred)`.
|
|
13
|
+
- Leave the MVP list as written once its features ship. Do not renumber it, extend it, or annotate an entry with status.
|
|
14
|
+
- Add later scope as a new section rather than as an extension of the MVP list.
|
|
15
|
+
- Drop a section rather than pad it. Include `## Distribution` only when the project ships outside its own repository.
|
|
16
|
+
|
|
9
17
|
## Authority
|
|
10
18
|
|
|
11
19
|
- Follow `.claude/standards/requirements.md` for what belongs in the problem, goals, non-goals, MVP features, tech stack, and constraints. It is the single source.
|
|
@@ -6,6 +6,16 @@ paths:
|
|
|
6
6
|
|
|
7
7
|
# Architecture standards
|
|
8
8
|
|
|
9
|
+
## Decisions
|
|
10
|
+
|
|
11
|
+
- Give each decision its own H3 under `## Key technical decisions`, naming what it chose and the alternative it passed over.
|
|
12
|
+
- Keep line-by-line function behavior and full type definitions out.
|
|
13
|
+
|
|
14
|
+
## Verification anchors
|
|
15
|
+
|
|
16
|
+
- Close a decision citing a measured number with `Measured at <short-sha> on <YYYY-MM-DD>.` Leave a decision citing none unanchored.
|
|
17
|
+
- Refresh that anchor whenever the number is re-read, whether or not it moved.
|
|
18
|
+
|
|
9
19
|
## Authority
|
|
10
20
|
|
|
11
21
|
- Follow `.claude/standards/architecture.md` for the overview, named decision entries, and risks. It is the single source.
|
|
@@ -6,6 +6,14 @@ paths:
|
|
|
6
6
|
|
|
7
7
|
# Design standards
|
|
8
8
|
|
|
9
|
+
## Tokens
|
|
10
|
+
|
|
11
|
+
- Describe a token as intent rather than as a computed value.
|
|
12
|
+
- Keep CSS classes, component filenames, and prop names out.
|
|
13
|
+
- Carry a token system as a table, one row per token, and a component rule as a short bullet.
|
|
14
|
+
- Keep the token table headers verbatim.
|
|
15
|
+
- Record a non-obvious omission, such as no motion or no custom icons.
|
|
16
|
+
|
|
9
17
|
## Authority
|
|
10
18
|
|
|
11
19
|
- Follow `.claude/standards/design.md` for visual intent, the token tables, and the render contract. It is the single source.
|
|
@@ -6,6 +6,14 @@ paths:
|
|
|
6
6
|
|
|
7
7
|
# Tasks standards
|
|
8
8
|
|
|
9
|
+
## What a task carries
|
|
10
|
+
|
|
11
|
+
- Name where the task came from, through a `Plan:`, `Groundwork:`, `Intake:`, or `Issue:` line under the title.
|
|
12
|
+
- Size the outcomes so one pull request closes all of them. Split the task before handing it off.
|
|
13
|
+
- Use `## Outcomes` and `## Findings` and add no third heading. Note status inline on an outcome.
|
|
14
|
+
- Keep class names, file paths, function names, and prop names out of every entry and title.
|
|
15
|
+
- Never delete a task file. A shipped task moves to the archive under its own name.
|
|
16
|
+
|
|
9
17
|
## Authority
|
|
10
18
|
|
|
11
19
|
- Follow `.claude/standards/tasks.md` for filenames, frontmatter, what belongs, and the task file format. It is the single source.
|
|
@@ -6,6 +6,14 @@ paths:
|
|
|
6
6
|
|
|
7
7
|
# README standards
|
|
8
8
|
|
|
9
|
+
## Audience and voice
|
|
10
|
+
|
|
11
|
+
- Write a repository-root README for someone deciding whether to commit to the project. A nested README keeps the reference voice.
|
|
12
|
+
- Address the reader in second person.
|
|
13
|
+
- Ground a claim in a command, a number, or a named constraint rather than an adjective.
|
|
14
|
+
- Name what the project does not do.
|
|
15
|
+
- Link out to full API documentation, license text, contribution guidelines, and troubleshooting rather than carrying them.
|
|
16
|
+
|
|
9
17
|
## Authority
|
|
10
18
|
|
|
11
19
|
- Follow `.claude/standards/readme.md` for voice, structure, required and optional sections, heading hierarchy, badge classes, per-project-type content, and what to link out rather than inline. It is the single source.
|
|
@@ -6,6 +6,17 @@ paths:
|
|
|
6
6
|
|
|
7
7
|
# Rule authoring standards
|
|
8
8
|
|
|
9
|
+
## Numbering
|
|
10
|
+
|
|
11
|
+
- Name a rule `.claude/rules/<subdirectory>/<n>-<slug>.md`, taking a number that collides with neither the project's rules nor any installed shared set.
|
|
12
|
+
- Give every rule a numeric prefix and keep the slug to one to three kebab words.
|
|
13
|
+
|
|
14
|
+
## Body
|
|
15
|
+
|
|
16
|
+
- State one directive per bullet in imperative voice. Do not explain the reasoning behind a rule.
|
|
17
|
+
- Cut a rule that resists crisp one-line phrasing.
|
|
18
|
+
- Do not restate a rule a sibling rule or `CLAUDE.md` already owns. Point once.
|
|
19
|
+
|
|
9
20
|
## Authority
|
|
10
21
|
|
|
11
22
|
- Follow `.claude/standards/rule.md` for rule frontmatter, body shape, and voice. It is the single source.
|
|
@@ -7,6 +7,14 @@ paths:
|
|
|
7
7
|
|
|
8
8
|
# Standard authoring standards
|
|
9
9
|
|
|
10
|
+
## The scope statement
|
|
11
|
+
|
|
12
|
+
- Govern one document type per standard, or one attribute across every document.
|
|
13
|
+
- Open with a `## Scope` section naming what the standard governs and a `Does not govern:` list, placed above the shape rules.
|
|
14
|
+
- Put the governed path in backticks in the first sentence, anchored deep enough to resolve from a project root. Keep an attribute standard's first sentence free of backticks and say in it that it governs an attribute.
|
|
15
|
+
- Give each `Does not govern:` entry an excluded concern and the owner it goes to. Cut an entry naming no owner.
|
|
16
|
+
- Declare a yield, an exemption, or a handoff from both sides of the boundary.
|
|
17
|
+
|
|
10
18
|
## Authority
|
|
11
19
|
|
|
12
20
|
- Follow `.claude/standards/standard.md` for a standard's frontmatter, shape, scope, and success criterion. It is the single source.
|