@sniper.ai/core 2.0.0 → 3.1.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.
Files changed (210) hide show
  1. package/README.md +87 -98
  2. package/agents/analyst.md +29 -0
  3. package/agents/architect.md +38 -0
  4. package/agents/backend-dev.md +43 -0
  5. package/agents/code-reviewer.md +72 -0
  6. package/agents/doc-writer.md +60 -0
  7. package/agents/frontend-dev.md +43 -0
  8. package/agents/fullstack-dev.md +44 -0
  9. package/agents/gate-reviewer.md +72 -0
  10. package/agents/lead-orchestrator.md +51 -0
  11. package/agents/product-manager.md +40 -0
  12. package/agents/qa-engineer.md +37 -0
  13. package/agents/retro-analyst.md +104 -0
  14. package/checklists/discover.yaml +23 -0
  15. package/checklists/implement.yaml +28 -0
  16. package/checklists/ingest-document.yaml +18 -0
  17. package/checklists/ingest-extract.yaml +13 -0
  18. package/checklists/ingest-scan.yaml +18 -0
  19. package/checklists/multi-faceted-review.yaml +57 -0
  20. package/checklists/plan.yaml +36 -0
  21. package/checklists/refactor-analyze.yaml +19 -0
  22. package/checklists/review.yaml +29 -0
  23. package/claude-md.template +42 -0
  24. package/config.template.yaml +156 -0
  25. package/hooks/settings-hooks.json +40 -0
  26. package/hooks/signal-hooks.json +16 -0
  27. package/package.json +23 -5
  28. package/personas/cognitive/devils-advocate.md +24 -0
  29. package/personas/cognitive/performance-focused.md +23 -0
  30. package/personas/cognitive/security-first.md +24 -0
  31. package/protocols/explore.yaml +21 -0
  32. package/protocols/feature.yaml +47 -0
  33. package/protocols/full.yaml +65 -0
  34. package/protocols/hotfix.yaml +19 -0
  35. package/protocols/ingest.yaml +42 -0
  36. package/protocols/patch.yaml +30 -0
  37. package/protocols/refactor.yaml +43 -0
  38. package/schemas/checkpoint.schema.yaml +133 -0
  39. package/schemas/cost.schema.yaml +97 -0
  40. package/schemas/dependency-graph.schema.yaml +37 -0
  41. package/schemas/gate-result.schema.yaml +101 -0
  42. package/schemas/knowledge-manifest.schema.yaml +39 -0
  43. package/schemas/live-status.schema.yaml +122 -0
  44. package/schemas/protocol-meta.schema.yaml +58 -0
  45. package/schemas/protocol.schema.yaml +100 -0
  46. package/schemas/retro.schema.yaml +95 -0
  47. package/schemas/revert-plan.schema.yaml +40 -0
  48. package/schemas/signal.schema.yaml +39 -0
  49. package/schemas/velocity.schema.yaml +52 -0
  50. package/schemas/workspace-lock.schema.yaml +34 -0
  51. package/schemas/workspace.schema.yaml +82 -0
  52. package/skills/sniper-flow/SKILL.md +196 -0
  53. package/skills/sniper-init/SKILL.md +102 -0
  54. package/skills/sniper-review/SKILL.md +49 -0
  55. package/skills/sniper-status/SKILL.md +79 -0
  56. package/templates/architecture.md +23 -0
  57. package/templates/checkpoint.yaml +27 -0
  58. package/templates/codebase-overview.md +19 -0
  59. package/templates/cost.yaml +23 -0
  60. package/templates/custom-protocol.yaml +98 -0
  61. package/templates/knowledge-manifest.yaml +32 -0
  62. package/templates/live-status.yaml +26 -0
  63. package/templates/multi-faceted-review-report.md +28 -0
  64. package/templates/registry.md +4 -0
  65. package/templates/review-report.md +25 -0
  66. package/templates/signal-record.yaml +37 -0
  67. package/templates/spec.md +28 -0
  68. package/templates/story.md +19 -0
  69. package/templates/velocity.yaml +9 -0
  70. package/templates/workspace-config.yaml +44 -0
  71. package/framework/checklists/code-review.md +0 -33
  72. package/framework/checklists/debug-review.md +0 -34
  73. package/framework/checklists/discover-review.md +0 -33
  74. package/framework/checklists/doc-review.md +0 -39
  75. package/framework/checklists/feature-review.md +0 -42
  76. package/framework/checklists/ingest-review.md +0 -42
  77. package/framework/checklists/memory-review.md +0 -30
  78. package/framework/checklists/perf-review.md +0 -33
  79. package/framework/checklists/plan-review.md +0 -52
  80. package/framework/checklists/refactor-review.md +0 -33
  81. package/framework/checklists/security-review.md +0 -34
  82. package/framework/checklists/sprint-review.md +0 -41
  83. package/framework/checklists/story-review.md +0 -30
  84. package/framework/checklists/test-review.md +0 -32
  85. package/framework/checklists/workspace-review.md +0 -34
  86. package/framework/claude-md.template +0 -37
  87. package/framework/commands/sniper-audit.md +0 -1549
  88. package/framework/commands/sniper-compose.md +0 -323
  89. package/framework/commands/sniper-debug.md +0 -337
  90. package/framework/commands/sniper-discover.md +0 -423
  91. package/framework/commands/sniper-doc.md +0 -441
  92. package/framework/commands/sniper-feature.md +0 -515
  93. package/framework/commands/sniper-ingest.md +0 -506
  94. package/framework/commands/sniper-init.md +0 -388
  95. package/framework/commands/sniper-memory.md +0 -219
  96. package/framework/commands/sniper-plan.md +0 -630
  97. package/framework/commands/sniper-review.md +0 -369
  98. package/framework/commands/sniper-solve.md +0 -408
  99. package/framework/commands/sniper-sprint.md +0 -716
  100. package/framework/commands/sniper-status.md +0 -481
  101. package/framework/commands/sniper-workspace-feature.md +0 -267
  102. package/framework/commands/sniper-workspace-init.md +0 -252
  103. package/framework/commands/sniper-workspace-status.md +0 -112
  104. package/framework/commands/sniper-workspace-validate.md +0 -138
  105. package/framework/config.template.yaml +0 -196
  106. package/framework/personas/cognitive/devils-advocate.md +0 -30
  107. package/framework/personas/cognitive/mentor-explainer.md +0 -29
  108. package/framework/personas/cognitive/performance-focused.md +0 -30
  109. package/framework/personas/cognitive/security-first.md +0 -29
  110. package/framework/personas/cognitive/systems-thinker.md +0 -29
  111. package/framework/personas/cognitive/user-empathetic.md +0 -29
  112. package/framework/personas/domain/.gitkeep +0 -0
  113. package/framework/personas/process/analyst.md +0 -29
  114. package/framework/personas/process/architect.md +0 -30
  115. package/framework/personas/process/architecture-cartographer.md +0 -25
  116. package/framework/personas/process/code-archaeologist.md +0 -22
  117. package/framework/personas/process/code-investigator.md +0 -29
  118. package/framework/personas/process/code-reviewer.md +0 -26
  119. package/framework/personas/process/contract-designer.md +0 -31
  120. package/framework/personas/process/convention-miner.md +0 -27
  121. package/framework/personas/process/coverage-analyst.md +0 -24
  122. package/framework/personas/process/developer.md +0 -32
  123. package/framework/personas/process/doc-analyst.md +0 -63
  124. package/framework/personas/process/doc-reviewer.md +0 -62
  125. package/framework/personas/process/doc-writer.md +0 -42
  126. package/framework/personas/process/flake-hunter.md +0 -30
  127. package/framework/personas/process/impact-analyst.md +0 -23
  128. package/framework/personas/process/integration-validator.md +0 -29
  129. package/framework/personas/process/log-analyst.md +0 -22
  130. package/framework/personas/process/migration-architect.md +0 -24
  131. package/framework/personas/process/perf-profiler.md +0 -27
  132. package/framework/personas/process/product-manager.md +0 -32
  133. package/framework/personas/process/qa-engineer.md +0 -31
  134. package/framework/personas/process/release-manager.md +0 -23
  135. package/framework/personas/process/retro-analyst.md +0 -30
  136. package/framework/personas/process/scrum-master.md +0 -31
  137. package/framework/personas/process/threat-modeler.md +0 -30
  138. package/framework/personas/process/triage-lead.md +0 -23
  139. package/framework/personas/process/ux-designer.md +0 -31
  140. package/framework/personas/process/vuln-scanner.md +0 -27
  141. package/framework/personas/process/workspace-orchestrator.md +0 -30
  142. package/framework/personas/technical/ai-ml.md +0 -33
  143. package/framework/personas/technical/api-design.md +0 -32
  144. package/framework/personas/technical/backend.md +0 -32
  145. package/framework/personas/technical/database.md +0 -32
  146. package/framework/personas/technical/frontend.md +0 -33
  147. package/framework/personas/technical/infrastructure.md +0 -32
  148. package/framework/personas/technical/security.md +0 -34
  149. package/framework/settings.template.json +0 -6
  150. package/framework/spawn-prompts/_template.md +0 -25
  151. package/framework/teams/debug.yaml +0 -56
  152. package/framework/teams/discover.yaml +0 -57
  153. package/framework/teams/doc.yaml +0 -76
  154. package/framework/teams/feature-plan.yaml +0 -61
  155. package/framework/teams/ingest.yaml +0 -85
  156. package/framework/teams/perf.yaml +0 -33
  157. package/framework/teams/plan.yaml +0 -86
  158. package/framework/teams/refactor.yaml +0 -34
  159. package/framework/teams/retro.yaml +0 -30
  160. package/framework/teams/review-pr.yaml +0 -73
  161. package/framework/teams/review-release.yaml +0 -70
  162. package/framework/teams/security.yaml +0 -59
  163. package/framework/teams/solve.yaml +0 -48
  164. package/framework/teams/sprint.yaml +0 -68
  165. package/framework/teams/test.yaml +0 -59
  166. package/framework/teams/workspace-feature.yaml +0 -69
  167. package/framework/teams/workspace-validation.yaml +0 -27
  168. package/framework/templates/arch-delta.md +0 -74
  169. package/framework/templates/architecture.md +0 -95
  170. package/framework/templates/brief.md +0 -73
  171. package/framework/templates/bug-report.md +0 -55
  172. package/framework/templates/contract-validation-report.md +0 -68
  173. package/framework/templates/contract.yaml +0 -60
  174. package/framework/templates/conventions.md +0 -59
  175. package/framework/templates/coverage-report.md +0 -67
  176. package/framework/templates/doc-api.md +0 -53
  177. package/framework/templates/doc-guide.md +0 -35
  178. package/framework/templates/doc-readme.md +0 -49
  179. package/framework/templates/epic.md +0 -47
  180. package/framework/templates/feature-brief.md +0 -54
  181. package/framework/templates/feature-spec.md +0 -53
  182. package/framework/templates/flaky-report.md +0 -64
  183. package/framework/templates/investigation.md +0 -49
  184. package/framework/templates/memory-anti-pattern.yaml +0 -16
  185. package/framework/templates/memory-convention.yaml +0 -17
  186. package/framework/templates/memory-decision.yaml +0 -16
  187. package/framework/templates/migration-plan.md +0 -47
  188. package/framework/templates/optimization-plan.md +0 -59
  189. package/framework/templates/performance-profile.md +0 -64
  190. package/framework/templates/personas.md +0 -118
  191. package/framework/templates/postmortem.md +0 -69
  192. package/framework/templates/pr-review.md +0 -50
  193. package/framework/templates/prd.md +0 -92
  194. package/framework/templates/refactor-scope.md +0 -52
  195. package/framework/templates/release-readiness.md +0 -66
  196. package/framework/templates/retro.yaml +0 -44
  197. package/framework/templates/risks.md +0 -64
  198. package/framework/templates/security.md +0 -111
  199. package/framework/templates/sprint-review.md +0 -32
  200. package/framework/templates/story.md +0 -53
  201. package/framework/templates/threat-model.md +0 -71
  202. package/framework/templates/ux-spec.md +0 -71
  203. package/framework/templates/vulnerability-report.md +0 -56
  204. package/framework/templates/workspace-brief.md +0 -52
  205. package/framework/templates/workspace-plan.md +0 -50
  206. package/framework/workflows/discover-only.md +0 -39
  207. package/framework/workflows/full-lifecycle.md +0 -56
  208. package/framework/workflows/quick-feature.md +0 -44
  209. package/framework/workflows/sprint-cycle.md +0 -47
  210. package/framework/workflows/workspace-feature.md +0 -71
@@ -1,59 +0,0 @@
1
- # ─────────────────────────────────────────
2
- # SNIPER Test & Coverage Audit Team
3
- # Structured test quality analysis
4
- # ─────────────────────────────────────────
5
-
6
- # Phase 1 (Analysis) spawns 2 agents in parallel:
7
- # - coverage-analyst: identifies coverage gaps ranked by risk
8
- # - flake-hunter: investigates flaky tests and diagnoses root causes
9
- #
10
- # Phase 2 (Planning) is run by the lead to generate improvement stories.
11
- # Phase 3 (Execution) uses the standard sprint infrastructure.
12
- #
13
- # This team YAML is used by /sniper-audit --target tests.
14
-
15
- team_name: sniper-test-audit-{audit_id}
16
- description: "Test & Coverage Audit: {audit_title}"
17
- model_override: null
18
-
19
- teammates:
20
- - name: coverage-analyst
21
- compose:
22
- process: coverage-analyst
23
- technical: null
24
- cognitive: systems-thinker
25
- tasks:
26
- - id: coverage-analysis
27
- name: "Coverage Gap Analysis"
28
- description: >
29
- Analyze test coverage across the codebase. Identify untested code paths,
30
- rank coverage gaps by risk (business-critical paths first), and produce
31
- a coverage report with prioritized recommendations for new tests.
32
- output: coverage-report.md
33
- blocked_by: []
34
- plan_approval: false
35
-
36
- - name: flake-hunter
37
- compose:
38
- process: flake-hunter
39
- technical: null
40
- cognitive: devils-advocate
41
- tasks:
42
- - id: flake-investigation
43
- name: "Flaky Test Investigation"
44
- description: >
45
- Investigate flaky tests in the test suite. Identify tests with
46
- non-deterministic behavior, diagnose root causes (timing, shared state,
47
- external dependencies), and produce a report with specific fixes for
48
- each flaky test.
49
- output: flaky-report.md
50
- blocked_by: []
51
- plan_approval: false
52
-
53
- # Phase 3 (Execution) reuses sprint teammates from sprint.yaml
54
-
55
- coordination: []
56
-
57
- review_gate:
58
- checklist: .sniper/checklists/test-review.md
59
- mode: flexible
@@ -1,69 +0,0 @@
1
- team_name: sniper-workspace-feature
2
- phase: workspace-feature
3
-
4
- teammates:
5
- - name: orchestrator
6
- compose:
7
- process: workspace-orchestrator
8
- technical: null
9
- cognitive: systems-thinker
10
- domain: null
11
- tasks:
12
- - id: workspace-brief
13
- name: "Workspace Feature Brief"
14
- output: "features/WKSP-{XXXX}/brief.md"
15
- template: ".sniper/templates/workspace-brief.md"
16
- reads:
17
- - "workspace.yaml"
18
- - "repositories/*/docs/architecture.md"
19
- plan_approval: true
20
- description: >
21
- Analyze the workspace to determine which repositories are affected by the
22
- feature. Read each repo's architecture docs. Produce a workspace feature
23
- brief that identifies affected repos, required interface changes, and
24
- implementation wave ordering based on the dependency graph.
25
-
26
- - id: cross-repo-plan
27
- name: "Cross-Repo Implementation Plan"
28
- output: "features/WKSP-{XXXX}/plan.md"
29
- template: ".sniper/templates/workspace-plan.md"
30
- reads:
31
- - "features/WKSP-{XXXX}/brief.md"
32
- - "contracts/"
33
- blocked_by: [contract-generation]
34
- plan_approval: true
35
- description: >
36
- After contracts are designed, produce the cross-repo implementation plan.
37
- Break down work per repository, define sprint wave ordering, and specify
38
- integration validation criteria between waves.
39
-
40
- - name: contract-designer
41
- compose:
42
- process: contract-designer
43
- technical: api-design
44
- cognitive: systems-thinker
45
- domain: null
46
- tasks:
47
- - id: contract-generation
48
- name: "Interface Contract Design"
49
- output: "contracts/"
50
- template: ".sniper/templates/contract.yaml"
51
- reads:
52
- - "features/WKSP-{XXXX}/brief.md"
53
- - "contracts/"
54
- - "repositories/*/docs/architecture.md"
55
- blocked_by: [workspace-brief]
56
- plan_approval: true
57
- description: >
58
- Based on the workspace feature brief, design interface contracts for
59
- all cross-repo communication. Define API endpoints with full schemas,
60
- shared type specifications, and event contracts. Version appropriately
61
- and ensure each side can be implemented independently.
62
-
63
- coordination:
64
- - between: [orchestrator, contract-designer]
65
- topic: "Interface boundaries and contract scope — what needs formal contracts vs. what can be informal"
66
-
67
- review_gate:
68
- checklist: ".sniper/checklists/workspace-review.md"
69
- mode: strict
@@ -1,27 +0,0 @@
1
- team_name: sniper-workspace-validation
2
- phase: workspace-validation
3
-
4
- teammates:
5
- - name: validator
6
- compose:
7
- process: integration-validator
8
- technical: backend
9
- cognitive: devils-advocate
10
- domain: null
11
- tasks:
12
- - id: contract-validation
13
- name: "Contract Compliance Validation"
14
- output: "features/WKSP-{XXXX}/validation-wave-{N}.md"
15
- template: ".sniper/templates/contract-validation-report.md"
16
- reads:
17
- - "contracts/"
18
- - "repositories/*/src/"
19
- description: >
20
- Validate that each repository's implementation matches the agreed-upon
21
- contracts. Check API endpoints, shared types, and event schemas. Report
22
- pass/fail for each contract item with specific mismatch details. Generate
23
- fix stories for any failures.
24
-
25
- coordination: []
26
-
27
- review_gate: null
@@ -1,74 +0,0 @@
1
- # Architecture Delta: {title}
2
-
3
- > **Feature ID:** SNPR-{XXXX}
4
- > **Version:** 1
5
- > **Status:** Draft
6
- > **Date:** {date}
7
- > **Author:** Feature Planning Team — Architect
8
- > **Base Architecture:** `docs/architecture.md` (version {N})
9
- > **Change Log:**
10
- > - v1 ({date}): Initial version
11
-
12
- ## Summary of Changes
13
- <!-- sniper:managed:summary:start -->
14
- <!-- 2-3 sentence overview of what changes to the architecture -->
15
- <!-- sniper:managed:summary:end -->
16
-
17
- ## New Components
18
- <!-- sniper:managed:new-components:start -->
19
- <!-- Components being added to the system -->
20
-
21
- ### {Component Name}
22
- - **Responsibility:**
23
- - **Interfaces:**
24
- - **Dependencies:**
25
-
26
- <!-- sniper:managed:new-components:end -->
27
-
28
- ## Modified Components
29
- <!-- sniper:managed:modified-components:start -->
30
- <!-- Existing components that need changes -->
31
-
32
- ### {Existing Component Name}
33
- - **Current behavior:**
34
- - **New behavior:**
35
- - **Migration notes:**
36
-
37
- <!-- sniper:managed:modified-components:end -->
38
-
39
- ## New Data Models
40
- <!-- sniper:managed:new-data-models:start -->
41
- <!-- New entities or modified schemas -->
42
-
43
- | Field | Type | Constraints | Index | Notes |
44
- |-------|------|------------|-------|-------|
45
- | | | | | |
46
-
47
- <!-- sniper:managed:new-data-models:end -->
48
-
49
- ## New/Modified API Endpoints
50
- <!-- sniper:managed:api-endpoints:start -->
51
- ```
52
- METHOD /api/v1/{resource}
53
- Request: { }
54
- Response: { }
55
- Status Codes: 200, 400, 401, 404, 500
56
- Auth: Required
57
- ```
58
- <!-- sniper:managed:api-endpoints:end -->
59
-
60
- ## Infrastructure Changes
61
- <!-- sniper:managed:infrastructure:start -->
62
- <!-- Any new services, queues, caches, etc. -->
63
- <!-- sniper:managed:infrastructure:end -->
64
-
65
- ## Patterns to Follow
66
- <!-- sniper:managed:patterns:start -->
67
- <!-- Reference existing architecture patterns that should be followed -->
68
- <!-- From docs/conventions.md if available -->
69
- <!-- sniper:managed:patterns:end -->
70
-
71
- ## Risks
72
- <!-- sniper:managed:risks:start -->
73
- <!-- Architecture risks specific to this feature -->
74
- <!-- sniper:managed:risks:end -->
@@ -1,95 +0,0 @@
1
- # System Architecture: {project_name}
2
-
3
- > **Version:** 1
4
- > **Status:** Draft
5
- > **Last Updated:** {date}
6
- > **Author:** Planning Team — Architect
7
- > **Source:** `docs/prd.md`, `docs/brief.md`
8
- > **Change Log:**
9
- > - v1 ({date}): Initial version
10
-
11
- ## 1. Architecture Overview
12
- <!-- sniper:managed:overview:start -->
13
- <!-- High-level system description. Include an ASCII or Mermaid component diagram. -->
14
- <!-- sniper:managed:overview:end -->
15
-
16
- ## 2. Technology Choices
17
- <!-- sniper:managed:technology-choices:start -->
18
- | Component | Choice | Why | Alternatives Considered |
19
- |-----------|--------|-----|------------------------|
20
- | Language | | | |
21
- | Frontend | | | |
22
- | Backend | | | |
23
- | Database | | | |
24
- | Cache | | | |
25
- | Queue | | | |
26
- | Infrastructure | | | |
27
- <!-- sniper:managed:technology-choices:end -->
28
-
29
- ## 3. Component Architecture
30
- <!-- sniper:managed:components:start -->
31
- <!-- Describe each major component, its responsibility, and its interfaces -->
32
-
33
- ### 3.1 {Component Name}
34
- - **Responsibility:**
35
- - **Interfaces:**
36
- - **Dependencies:**
37
- <!-- sniper:managed:components:end -->
38
-
39
- ## 4. Data Models
40
- <!-- sniper:managed:data-models:start -->
41
- <!-- Entity-relationship descriptions with field types, constraints, indexes -->
42
-
43
- ### 4.1 {Entity Name}
44
- | Field | Type | Constraints | Index | Notes |
45
- |-------|------|------------|-------|-------|
46
- | | | | | |
47
- <!-- sniper:managed:data-models:end -->
48
-
49
- ## 5. API Contracts
50
- <!-- sniper:managed:api-contracts:start -->
51
- <!-- RESTful endpoints with methods, paths, request/response payloads -->
52
-
53
- ### 5.1 {Resource}
54
- ```
55
- METHOD /api/v1/{resource}
56
- Request: { }
57
- Response: { }
58
- Status Codes: 200, 400, 401, 404, 500
59
- Auth: Required
60
- ```
61
- <!-- sniper:managed:api-contracts:end -->
62
-
63
- ## 6. Infrastructure Topology
64
- <!-- sniper:managed:infrastructure:start -->
65
- <!-- Compute, storage, networking, scaling strategy -->
66
- <!-- sniper:managed:infrastructure:end -->
67
-
68
- ## 7. Cross-Cutting Concerns
69
-
70
- <!-- sniper:managed:cross-cutting:start -->
71
- ### 7.1 Authentication & Authorization
72
- ### 7.2 Logging & Monitoring
73
- ### 7.3 Error Handling
74
- ### 7.4 Configuration Management
75
- <!-- sniper:managed:cross-cutting:end -->
76
-
77
- ## 8. Non-Functional Requirements
78
- <!-- sniper:managed:nfr:start -->
79
- | Requirement | Target | Strategy |
80
- |-------------|--------|----------|
81
- | Response time (p95) | | |
82
- | Availability | | |
83
- | Throughput | | |
84
- | Data retention | | |
85
- <!-- sniper:managed:nfr:end -->
86
-
87
- ## 9. Migration & Deployment Strategy
88
- <!-- sniper:managed:deployment:start -->
89
- <!-- How the system gets deployed. CI/CD, blue-green, rollback strategy. -->
90
- <!-- sniper:managed:deployment:end -->
91
-
92
- ## 10. Security Architecture
93
- <!-- sniper:managed:security:start -->
94
- <!-- Reference docs/security.md for detailed security requirements -->
95
- <!-- sniper:managed:security:end -->
@@ -1,73 +0,0 @@
1
- # Project Brief: {project_name}
2
-
3
- > **Version:** 1
4
- > **Status:** Draft
5
- > **Last Updated:** {date}
6
- > **Author:** Discovery Team — Analyst
7
- > **Change Log:**
8
- > - v1 ({date}): Initial version
9
-
10
- ## Executive Summary
11
- <!-- sniper:managed:executive-summary:start -->
12
- <!-- 2-3 sentence overview of the project and its value proposition -->
13
- <!-- sniper:managed:executive-summary:end -->
14
-
15
- ## Problem Statement
16
- <!-- sniper:managed:problem-statement:start -->
17
- <!-- What problem does this solve? Who has this problem? How is it currently solved? -->
18
- <!-- sniper:managed:problem-statement:end -->
19
-
20
- ## Market Landscape
21
-
22
- <!-- sniper:managed:market-landscape:start -->
23
- ### Direct Competitors
24
- | Competitor | Key Features | Pricing | Market Position | Weaknesses |
25
- |-----------|-------------|---------|-----------------|------------|
26
- | | | | | |
27
-
28
- ### Indirect Competitors / Alternatives
29
- <!-- How are users solving this problem today without a dedicated tool? -->
30
- <!-- sniper:managed:market-landscape:end -->
31
-
32
- ## Target Market
33
- <!-- sniper:managed:target-market:start -->
34
- - **Primary segment:** <!-- Who is the ideal customer? -->
35
- - **Market size:** <!-- TAM/SAM/SOM estimates if available -->
36
- - **Growth trends:** <!-- Is this market growing? Why? -->
37
- <!-- sniper:managed:target-market:end -->
38
-
39
- ## Unique Value Proposition
40
- <!-- sniper:managed:value-proposition:start -->
41
- <!-- What makes this product different from everything else? Be specific. -->
42
- <!-- sniper:managed:value-proposition:end -->
43
-
44
- ## Key Assumptions
45
- <!-- sniper:managed:assumptions:start -->
46
- <!-- List assumptions that need validation. These are things you believe but haven't proven. -->
47
- 1.
48
- 2.
49
- 3.
50
- <!-- sniper:managed:assumptions:end -->
51
-
52
- ## Technical Constraints
53
- <!-- sniper:managed:technical-constraints:start -->
54
- <!-- Known technical limitations, required integrations, regulatory requirements -->
55
- <!-- sniper:managed:technical-constraints:end -->
56
-
57
- ## Initial Scope Recommendation
58
- <!-- sniper:managed:scope:start -->
59
- <!-- What should v1 include? What should it NOT include? -->
60
-
61
- ### In Scope (v1)
62
- -
63
-
64
- ### Out of Scope (v1)
65
- -
66
- <!-- sniper:managed:scope:end -->
67
-
68
- ## Open Questions
69
- <!-- sniper:managed:open-questions:start -->
70
- <!-- Questions that need answers before planning can begin -->
71
- 1.
72
- 2.
73
- <!-- sniper:managed:open-questions:end -->
@@ -1,55 +0,0 @@
1
- # Bug Report: {title}
2
-
3
- > **Bug ID:** BUG-{NNN}
4
- > **Severity:** {critical/high/medium/low}
5
- > **Status:** Triaging
6
- > **Date:** {date}
7
- > **Author:** Triage Lead
8
- > **Source:** {user description / GitHub issue GH-{NNN}}
9
-
10
- ## Bug Summary
11
- <!-- sniper:managed:summary:start -->
12
- <!-- One-paragraph description of the observed behavior -->
13
- <!-- sniper:managed:summary:end -->
14
-
15
- ## Severity Assessment
16
- <!-- sniper:managed:severity:start -->
17
- <!-- Severity level with justification based on user impact -->
18
- <!-- sniper:managed:severity:end -->
19
-
20
- ## Affected Components
21
- <!-- sniper:managed:affected-components:start -->
22
-
23
- | Component | Impact | Notes |
24
- |-----------|--------|-------|
25
- | | Direct / Indirect | |
26
-
27
- <!-- sniper:managed:affected-components:end -->
28
-
29
- ## Reproduction Steps
30
- <!-- sniper:managed:reproduction:start -->
31
- <!-- Inferred from bug description. Note "Unable to determine" for unknown steps -->
32
- 1.
33
- <!-- sniper:managed:reproduction:end -->
34
-
35
- ## Error Context
36
- <!-- sniper:managed:error-context:start -->
37
- <!-- Error messages, stack traces, affected endpoints, HTTP status codes -->
38
- <!-- sniper:managed:error-context:end -->
39
-
40
- ## Hypothesis
41
- <!-- sniper:managed:hypothesis:start -->
42
- <!-- Initial theory about what might be causing the issue -->
43
- <!-- sniper:managed:hypothesis:end -->
44
-
45
- ## Investigation Plan
46
- <!-- sniper:managed:investigation-plan:start -->
47
- <!-- What the investigation team should look at -->
48
-
49
- ### For Log Analyst
50
- -
51
-
52
- ### For Code Investigator
53
- -
54
-
55
- <!-- sniper:managed:investigation-plan:end -->
@@ -1,68 +0,0 @@
1
- # Contract Validation Report
2
-
3
- > **Feature:** WKSP-{XXXX}
4
- > **Wave:** {N}
5
- > **Date:** {date}
6
- > **Validator:** Integration Validator
7
-
8
- ## Summary
9
- <!-- sniper:managed:summary:start -->
10
- | Metric | Count |
11
- |--------|-------|
12
- | Contracts validated | 0 |
13
- | Endpoints checked | 0 |
14
- | Shared types checked | 0 |
15
- | Events checked | 0 |
16
- | **Passed** | 0 |
17
- | **Failed** | 0 |
18
- | **Warnings** | 0 |
19
- <!-- sniper:managed:summary:end -->
20
-
21
- ## Contract Results
22
- <!-- sniper:managed:contract-results:start -->
23
-
24
- ### {contract-name} (v{version})
25
-
26
- #### Endpoints
27
- | Endpoint | Method | Status | Notes |
28
- |----------|--------|--------|-------|
29
- | | | ✅ / ❌ | |
30
-
31
- #### Shared Types
32
- | Type | Owner | Status | Notes |
33
- |------|-------|--------|-------|
34
- | | | ✅ / ❌ | |
35
-
36
- #### Events
37
- | Event | Producer | Status | Notes |
38
- |-------|----------|--------|-------|
39
- | | | ✅ / ❌ | |
40
-
41
- <!-- sniper:managed:contract-results:end -->
42
-
43
- ## Mismatches
44
- <!-- sniper:managed:mismatches:start -->
45
-
46
- ### {mismatch-title}
47
- - **Contract:** {what the contract specifies}
48
- - **Actual:** {what the implementation does}
49
- - **Location:** `{repo}/{file}:{line}`
50
- - **Severity:** Breaking / Non-Breaking
51
- - **Fix:** {what needs to change}
52
-
53
- <!-- sniper:managed:mismatches:end -->
54
-
55
- ## Fix Stories
56
- <!-- sniper:managed:fix-stories:start -->
57
- | Repo | Story Title | Priority |
58
- |------|-------------|----------|
59
- | | | |
60
- <!-- sniper:managed:fix-stories:end -->
61
-
62
- ## Verdict
63
- <!-- sniper:managed:verdict:start -->
64
- **{PASS / FAIL}** — {summary statement}
65
-
66
- {If FAIL: "The following must be resolved before Wave {N+1} can begin."}
67
- {If PASS: "All contracts validated. Wave {N+1} may proceed."}
68
- <!-- sniper:managed:verdict:end -->
@@ -1,60 +0,0 @@
1
- # Interface Contract Template
2
- # Produced by: contract-designer
3
- # Consumed by: per-repo feature leads, integration-validator
4
-
5
- contract:
6
- name: "" # e.g., api-web, api-shared
7
- between: [] # e.g., [api-service, web-app]
8
- version: "1.0.0" # semver — breaking changes increment major
9
- last_updated: "" # ISO 8601 date
10
- updated_by: "" # WKSP-XXXX feature that created/modified this
11
-
12
- # REST API endpoints
13
- endpoints:
14
- # - path: /api/v1/resource
15
- # method: GET | POST | PUT | PATCH | DELETE
16
- # description: ""
17
- # request_body: # For POST/PUT/PATCH
18
- # type: object
19
- # properties:
20
- # field_name:
21
- # type: string | number | boolean | object | array
22
- # required: true | false
23
- # description: ""
24
- # query_params: # For GET
25
- # - name: ""
26
- # type: string
27
- # required: false
28
- # response:
29
- # 200:
30
- # type: object
31
- # properties: {}
32
- # 400:
33
- # type: object
34
- # properties:
35
- # error: { type: string }
36
- # 404:
37
- # type: object
38
- # properties:
39
- # error: { type: string }
40
- []
41
-
42
- # Shared type definitions
43
- shared_types:
44
- # - name: TypeName
45
- # repo: shared-lib # Which repo owns and exports this type
46
- # path: src/types/type-name.ts # File path within the owning repo
47
- # definition: # TypeScript-style type shape
48
- # field: "type"
49
- []
50
-
51
- # Asynchronous event contracts
52
- events:
53
- # - name: entity.action.completed # e.g., user.preferences.updated
54
- # producer: api-service # Which repo emits this event
55
- # consumers: [web-app] # Which repos listen for this event
56
- # payload:
57
- # field:
58
- # type: string
59
- # description: ""
60
- []
@@ -1,59 +0,0 @@
1
- # Coding Conventions: {project_name}
2
-
3
- > **Version:** 1
4
- > **Status:** Draft
5
- > **Last Updated:** {date}
6
- > **Author:** Ingestion Team — Convention Miner
7
- > **Source:** Extracted from codebase analysis
8
- > **Change Log:**
9
- > - v1 ({date}): Initial version
10
-
11
- ## Naming Conventions
12
- <!-- sniper:managed:naming:start -->
13
- <!-- Variable naming (camelCase/snake_case), file naming, directory naming, exported symbols -->
14
- <!-- Include code examples from the actual codebase -->
15
- <!-- sniper:managed:naming:end -->
16
-
17
- ## Code Organization
18
- <!-- sniper:managed:code-org:start -->
19
- <!-- How files are structured within directories, barrel exports, index files, feature-based vs layer-based -->
20
- <!-- sniper:managed:code-org:end -->
21
-
22
- ## Error Handling Patterns
23
- <!-- sniper:managed:error-handling:start -->
24
- <!-- Custom error classes, error codes, error boundaries, try/catch patterns -->
25
- <!-- Include code examples -->
26
- <!-- sniper:managed:error-handling:end -->
27
-
28
- ## Testing Patterns
29
- <!-- sniper:managed:testing:start -->
30
- <!-- Test file location, test naming, mock patterns, fixtures, test utilities -->
31
- <!-- Include code examples -->
32
- <!-- sniper:managed:testing:end -->
33
-
34
- ## API Patterns
35
- <!-- sniper:managed:api-patterns:start -->
36
- <!-- Request validation, response formatting, middleware usage, auth checks -->
37
- <!-- Include code examples -->
38
- <!-- sniper:managed:api-patterns:end -->
39
-
40
- ## Import & Module Patterns
41
- <!-- sniper:managed:imports:start -->
42
- <!-- Absolute vs relative imports, import ordering, path aliases -->
43
- <!-- Include code examples -->
44
- <!-- sniper:managed:imports:end -->
45
-
46
- ## Configuration & Environment
47
- <!-- sniper:managed:config:start -->
48
- <!-- How env vars are accessed, config files, validation -->
49
- <!-- Include code examples -->
50
- <!-- sniper:managed:config:end -->
51
-
52
- ## Logging
53
- <!-- sniper:managed:logging:start -->
54
- <!-- Logging library, log levels, structured logging patterns -->
55
- <!-- Include code examples -->
56
- <!-- sniper:managed:logging:end -->
57
-
58
- ## Additional Conventions
59
- <!-- Add project-specific conventions not covered above -->