aimship 0.1.0-preview.4 → 0.1.0-preview.8

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.
Files changed (47) hide show
  1. package/CONTRIBUTING.md +59 -0
  2. package/README.md +126 -19
  3. package/README.zh-CN.md +127 -20
  4. package/docs/cli.md +68 -32
  5. package/docs/examples.md +5 -0
  6. package/docs/guide.md +181 -30
  7. package/docs/guide.zh-CN.md +210 -0
  8. package/docs/installation.md +19 -108
  9. package/docs/reference.md +78 -0
  10. package/docs/reference.zh-CN.md +78 -0
  11. package/lib/approvals.mjs +153 -0
  12. package/lib/cli.mjs +29 -16
  13. package/lib/documents.mjs +156 -0
  14. package/lib/migrate.mjs +77 -0
  15. package/lib/state.mjs +96 -24
  16. package/lib/view.mjs +75 -0
  17. package/package.json +3 -2
  18. package/skills/aimship/SKILL.md +2 -2
  19. package/skills/aimship/references/artifact-map.json +172 -0
  20. package/skills/aimship/references/core.md +12 -6
  21. package/skills/aimship/references/document-patterns.md +32 -10
  22. package/skills/aimship/references/document-review.md +28 -0
  23. package/skills/aimship/references/hosts.md +4 -2
  24. package/skills/aimship/references/recovery.md +10 -0
  25. package/skills/aimship/references/sources-and-changes.md +8 -0
  26. package/skills/aimship/references/stages/contract.md +10 -2
  27. package/skills/aimship/references/stages/diagnose.md +10 -0
  28. package/skills/aimship/references/stages/frame.md +4 -0
  29. package/skills/aimship/references/stages/handoff.md +4 -0
  30. package/skills/aimship/references/stages/implement.md +6 -0
  31. package/skills/aimship/references/stages/plan.md +10 -2
  32. package/skills/aimship/references/stages/prototype.md +8 -0
  33. package/skills/aimship/references/stages/requirements.md +8 -0
  34. package/skills/aimship/references/stages/review.md +4 -0
  35. package/skills/aimship/references/stages/scope.md +8 -0
  36. package/skills/aimship/references/stages/tech-design.md +11 -1
  37. package/skills/aimship/references/stages/test-design.md +9 -1
  38. package/skills/aimship/references/stages/verify.md +6 -0
  39. package/skills/aimship/references/templates/change-log.md +14 -0
  40. package/skills/aimship/references/templates/diagnosis.md +39 -0
  41. package/skills/aimship/references/templates/handoff.md +34 -0
  42. package/skills/aimship/references/templates/plan.md +35 -0
  43. package/skills/aimship/references/templates/prd.md +39 -0
  44. package/skills/aimship/references/templates/review.md +19 -0
  45. package/skills/aimship/references/templates/scope.md +39 -0
  46. package/skills/aimship/references/templates/tech-design.md +40 -0
  47. package/skills/aimship/references/templates/testing.md +35 -0
@@ -17,3 +17,9 @@ The agreed execution work is accounted for with traceable results. This run can
17
17
  Unavailable environment or authority stays explicit with a recovery action. Do not lower criteria, skip assertions or mark a case passed because a command exited successfully.
18
18
 
19
19
  Use [the shared core](../core.md) for state, evidence and continuation rules. Record meaningful results in an artifact or referenced section; a file alone is not completion.
20
+
21
+ ## Artifact contract
22
+
23
+ Use testing.md. Preserve the `runs` section anchor. Follow [document patterns](../document-patterns.md) and the single [artifact map](../artifact-map.json). Keep this run independent even when its document is shared. New runs need a precise result location; adopted work is not a newly executed stage.
24
+
25
+ Append RUN records in testing.md, referencing versioned TC and exact objects. Evidence goes in .aimship/evidence/; no installation diagnostics or repeated state output in ordinary deliveries.
@@ -0,0 +1,14 @@
1
+ # change-log
2
+
3
+ Delivery: <deliveryId from init>; document revision: <revision>.
4
+
5
+ <a id="changes"></a>
6
+ ## Important changes
7
+
8
+ CHG, reason/decision source, before/after, affected IDs/objects, actions/results and remaining work. Replace guidance with actual content; explain inapplicability, never prefill a result.
9
+
10
+ <a id="remaining"></a>
11
+ ## Unfinished impact handling
12
+
13
+ One decision stays one record; no edit audit. Replace guidance with actual content; explain inapplicability, never prefill a result.
14
+
@@ -0,0 +1,39 @@
1
+ # diagnosis
2
+
3
+ Delivery: <deliveryId from init>; document revision: <revision>.
4
+
5
+ <a id="goals"></a>
6
+ ## Investigation goal and scope
7
+
8
+ Commission and authorized scope. Replace guidance with actual content; explain inapplicability, never prefill a result.
9
+
10
+ <a id="symptoms"></a>
11
+ ## Observed and expected behavior
12
+
13
+ Facts versus hypotheses. Replace guidance with actual content; explain inapplicability, never prefill a result.
14
+
15
+ <a id="environment"></a>
16
+ ## Environment and reproduction
17
+
18
+ Exact versions and reproducible conditions. Replace guidance with actual content; explain inapplicability, never prefill a result.
19
+
20
+ <a id="evidence"></a>
21
+ ## Checks and evidence
22
+
23
+ Operations, observations and source refs. Replace guidance with actual content; explain inapplicability, never prefill a result.
24
+
25
+ <a id="causes"></a>
26
+ ## Cause assessment
27
+
28
+ Confirmed causes versus unverified hypotheses. Replace guidance with actual content; explain inapplicability, never prefill a result.
29
+
30
+ <a id="unknowns"></a>
31
+ ## Impact and unknowns
32
+
33
+ Dependent work and recovery conditions. Replace guidance with actual content; explain inapplicability, never prefill a result.
34
+
35
+ <a id="conclusion"></a>
36
+ ## Conclusion and next action
37
+
38
+ Investigation endpoint is not automatically repair completion. Replace guidance with actual content; explain inapplicability, never prefill a result.
39
+
@@ -0,0 +1,34 @@
1
+ # handoff
2
+
3
+ Delivery: <deliveryId from init>; document revision: <revision>.
4
+
5
+ <a id="goals"></a>
6
+ ## Current goal comparison
7
+
8
+ REQ/AC and actual results, including explicit goal changes. Replace guidance with actual content; explain inapplicability, never prefill a result.
9
+
10
+ <a id="artifacts"></a>
11
+ ## Artifacts, repositories and versions
12
+
13
+ Links, actual checkout/worktree, branch/commit and uncommitted paths; no Git uses file digests. Replace guidance with actual content; explain inapplicability, never prefill a result.
14
+
15
+ <a id="usage"></a>
16
+ ## Usage
17
+
18
+ Actual commands and entry points. Replace guidance with actual content; explain inapplicability, never prefill a result.
19
+
20
+ <a id="results"></a>
21
+ ## Review and verification
22
+
23
+ Scopes, versions, results and evidence. Replace guidance with actual content; explain inapplicability, never prefill a result.
24
+
25
+ <a id="limits"></a>
26
+ ## Limitations and remaining work
27
+
28
+ Unverified work and recovery conditions. Replace guidance with actual content; explain inapplicability, never prefill a result.
29
+
30
+ <a id="outcomes"></a>
31
+ ## Acceptance, integration, release and continuation
32
+
33
+ Independent facts; prepared version is not a release. Replace guidance with actual content; explain inapplicability, never prefill a result.
34
+
@@ -0,0 +1,35 @@
1
+ # plan
2
+
3
+ Delivery: <deliveryId from init>; document revision: <revision>.
4
+
5
+ <a id="basis"></a>
6
+ ## Implementation basis and scope
7
+
8
+ Current requirements, design, contracts and actual repositories. Replace guidance with actual content; explain inapplicability, never prefill a result.
9
+
10
+ <a id="batches"></a>
11
+ ## Batches and dependencies
12
+
13
+ B ID, goal, dependencies and integration arrangement. Replace guidance with actual content; explain inapplicability, never prefill a result.
14
+
15
+ <a id="tasks"></a>
16
+ ## Tasks and completion criteria
17
+
18
+ TASK, batch, REQ/AC or risk, repository ID, file/module, planned change, completion criteria, status, artifact ref. Replace guidance with actual content; explain inapplicability, never prefill a result.
19
+
20
+ <a id="validation"></a>
21
+ ## Review and independent verification arrangement
22
+
23
+ Each batch review, overall review then independent verification; no per-batch full test gates. Replace guidance with actual content; explain inapplicability, never prefill a result.
24
+
25
+ <a id="execution"></a>
26
+ ## Task status and execution records
27
+
28
+ Actual changes and object versions by TASK/B; preserve original plan and distinguish pre-existing changes. Replace guidance with actual content; explain inapplicability, never prefill a result.
29
+
30
+ <a id="remaining"></a>
31
+ ## Deviations, blockers and remaining work
32
+
33
+ Unfinished effects and recovery, not a second stage ledger. Replace guidance with actual content; explain inapplicability, never prefill a result.
34
+
35
+ <!-- Review guidance: retain the fixed outline. Technical design precedes interface/SQL production; test cases precede planning. Self-check and explicit document approval are separate from stage done. For plan/testing, keep execution records after execution/runs respectively. -->
@@ -0,0 +1,39 @@
1
+ # prd
2
+
3
+ Delivery: <deliveryId from init>; document revision: <revision>.
4
+
5
+ <a id="info"></a>
6
+ ## Document information and sources
7
+
8
+ Identify this delivery, revision and adopted inputs. Replace guidance with actual content; explain inapplicability, never prefill a result.
9
+
10
+ <a id="goals"></a>
11
+ ## Background, goals and non-goals
12
+
13
+ Separate known facts, requirements and assumptions. Replace guidance with actual content; explain inapplicability, never prefill a result.
14
+
15
+ <a id="scope"></a>
16
+ ## Scope, engineering objects and endpoint
17
+
18
+ Included/excluded work, repository IDs, authorization and endpoint. Replace guidance with actual content; explain inapplicability, never prefill a result.
19
+
20
+ <a id="requirements"></a>
21
+ ## Requirements and behavior
22
+
23
+ REQ, type, actor/object, trigger/precondition, behavior, observable result, boundaries/errors, source and AC. Shared business rules, access control (even one role), performance and reliability need independent identity when independently testable. Replace guidance with actual content; explain inapplicability, never prefill a result.
24
+
25
+ <a id="states"></a>
26
+ ## States, interaction and recovery
27
+
28
+ Allowed transitions, terminal states, errors and recovery; say why inapplicable. Replace guidance with actual content; explain inapplicability, never prefill a result.
29
+
30
+ <a id="acceptance"></a>
31
+ ## Acceptance criteria
32
+
33
+ AC, requirement reference, condition, operation, decidable expected result. Replace guidance with actual content; explain inapplicability, never prefill a result.
34
+
35
+ <a id="arrangement"></a>
36
+ ## Dependencies, questions and stage arrangement
37
+
38
+ Selected order, artifact locations/reuse, dependencies, Q with impact/status/decision source. Replace guidance with actual content; explain inapplicability, never prefill a result.
39
+
@@ -0,0 +1,19 @@
1
+ # review
2
+
3
+ Delivery: <deliveryId from init>; document revision: <revision>.
4
+
5
+ <a id="basis"></a>
6
+ ## Review basis and scope
7
+
8
+ Exact repositories/objects, baseline and differences. Replace guidance with actual content; explain inapplicability, never prefill a result.
9
+
10
+ <a id="reviews"></a>
11
+ ## Review records
12
+
13
+ REV, batch/overall/repair scope, TASK/REQ/AC, reviewer/date, findings, dispositions and recheck conclusions. Replace guidance with actual content; explain inapplicability, never prefill a result.
14
+
15
+ <a id="conclusion"></a>
16
+ ## Open findings and current conclusion
17
+
18
+ Preserve historical findings and old object basis; review is not execution. Replace guidance with actual content; explain inapplicability, never prefill a result.
19
+
@@ -0,0 +1,39 @@
1
+ # scope
2
+
3
+ Delivery: <deliveryId from init>; document revision: <revision>.
4
+
5
+ <a id="info"></a>
6
+ ## Document information and source versions
7
+
8
+ Delivery identity and adopted versions. Replace guidance with actual content; explain inapplicability, never prefill a result.
9
+
10
+ <a id="goals"></a>
11
+ ## Goal, engineering objects and endpoint
12
+
13
+ Actual repository IDs, authorized objects and endpoint. Replace guidance with actual content; explain inapplicability, never prefill a result.
14
+
15
+ <a id="adoption"></a>
16
+ ## Source mapping and adopted scope
17
+
18
+ Source/version/original ID or section, adoption decision, requirement reference, AC and gaps; do not copy the full PRD. Replace guidance with actual content; explain inapplicability, never prefill a result.
19
+
20
+ <a id="exclusions"></a>
21
+ ## Exclusions and constraints
22
+
23
+ Explicitly delimit this commission. Replace guidance with actual content; explain inapplicability, never prefill a result.
24
+
25
+ <a id="decisions"></a>
26
+ ## Conflicts, gaps and supplementary decisions
27
+
28
+ Preserve sources; identify decision authority and pending source updates. Replace guidance with actual content; explain inapplicability, never prefill a result.
29
+
30
+ <a id="acceptance"></a>
31
+ ## Acceptance basis
32
+
33
+ AC, requirement/source identity, conditions, actions and expected results. Replace guidance with actual content; explain inapplicability, never prefill a result.
34
+
35
+ <a id="arrangement"></a>
36
+ ## Authorization, questions and stage arrangement
37
+
38
+ Selected order, artifact locations/reuse, permissions and open Q. Replace guidance with actual content; explain inapplicability, never prefill a result.
39
+
@@ -0,0 +1,40 @@
1
+ # tech-design
2
+
3
+ Delivery: <deliveryId from init>; document revision: <revision>.
4
+
5
+ <a id="basis"></a>
6
+ ## Basis and engineering context
7
+
8
+ Current requirements and actual engineering constraints. Replace guidance with actual content; explain inapplicability, never prefill a result.
9
+
10
+ <a id="architecture"></a>
11
+ ## Architecture and key flows
12
+
13
+ Ordered explanation or diagram of the important flow. Replace guidance with actual content; explain inapplicability, never prefill a result.
14
+
15
+ <a id="modules"></a>
16
+ ## Modules and interaction implementation
17
+
18
+ Repository ID, responsibility, actual path, new/change, requirement refs; entry/state/data flow for interaction. Replace guidance with actual content; explain inapplicability, never prefill a result.
19
+
20
+ <a id="data"></a>
21
+ ## Data, interfaces and SQL
22
+
23
+ Structures, indexes, consistency, contract authority, database type/version/schema basis, SQL order and execution boundary. Replace guidance with actual content; explain inapplicability, never prefill a result.
24
+
25
+ <a id="errors"></a>
26
+ ## Errors and nonfunctional design
27
+
28
+ Recovery, access, performance, observability, cache/messages when relevant. Replace guidance with actual content; explain inapplicability, never prefill a result.
29
+
30
+ <a id="risks"></a>
31
+ ## Tradeoffs and risks
32
+
33
+ Reasons, alternatives, compatibility and technical risks. Replace guidance with actual content; explain inapplicability, never prefill a result.
34
+
35
+ <a id="coverage"></a>
36
+ ## Requirement coverage and questions
37
+
38
+ REQ/AC to module/operation/SQL section and unresolved Q. Replace guidance with actual content; explain inapplicability, never prefill a result.
39
+
40
+ <!-- Review guidance: retain the fixed outline. Technical design precedes interface/SQL production; test cases precede planning. Self-check and explicit document approval are separate from stage done. For plan/testing, keep execution records after execution/runs respectively. -->
@@ -0,0 +1,35 @@
1
+ # testing
2
+
3
+ Delivery: <deliveryId from init>; document revision: <revision>.
4
+
5
+ <a id="basis"></a>
6
+ ## Basis and scope
7
+
8
+ Current AC and risks; adopted cases location/version if verify-only. Replace guidance with actual content; explain inapplicability, never prefill a result.
9
+
10
+ <a id="environment"></a>
11
+ ## Environment, data and execution conditions
12
+
13
+ Tools, permissions, commands and unavailable conditions. Replace guidance with actual content; explain inapplicability, never prefill a result.
14
+
15
+ <a id="cases"></a>
16
+ ## Test cases
17
+
18
+ TC, case version, REQ/AC or risk, type/level, preconditions, operations, concrete expected result, method/entry. Replace guidance with actual content; explain inapplicability, never prefill a result.
19
+
20
+ <a id="coverage"></a>
21
+ ## Coverage and verification arrangement
22
+
23
+ AC, requirements, TC, gaps and execution group/order. Replace guidance with actual content; explain inapplicability, never prefill a result.
24
+
25
+ <a id="runs"></a>
26
+ ## Execution and retest records
27
+
28
+ RUN, TC@version, exact code/build or document object, command/operation, assertions, actual results and evidence. Not executed until actually run; append failures/retests. Replace guidance with actual content; explain inapplicability, never prefill a result.
29
+
30
+ <a id="conclusion"></a>
31
+ ## Defects, current conclusion and remaining work
32
+
33
+ Separate passed, failed, blocked and unexecuted; explain applicability after change. Replace guidance with actual content; explain inapplicability, never prefill a result.
34
+
35
+ <!-- Review guidance: retain the fixed outline. Technical design precedes interface/SQL production; test cases precede planning. Self-check and explicit document approval are separate from stage done. For plan/testing, keep execution records after execution/runs respectively. -->