@maggit/claude-workspace 0.1.1
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/LICENSE +21 -0
- package/README.md +228 -0
- package/assets/claude-md/default.md +34 -0
- package/assets/claude-md/engineering-exec.md +34 -0
- package/assets/claude-md/indie-maker.md +33 -0
- package/assets/claude-md/marketing.md +33 -0
- package/assets/profiles/default.json +46 -0
- package/assets/profiles/engineering-exec.json +42 -0
- package/assets/profiles/indie-maker.json +32 -0
- package/assets/profiles/marketing.json +27 -0
- package/assets/skills/adr/SKILL.md +66 -0
- package/assets/skills/apidoc/SKILL.md +78 -0
- package/assets/skills/changelog/SKILL.md +54 -0
- package/assets/skills/commit/SKILL.md +18 -0
- package/assets/skills/completetodo/SKILL.md +75 -0
- package/assets/skills/createtodo/SKILL.md +79 -0
- package/assets/skills/deadcode/SKILL.md +56 -0
- package/assets/skills/debug/SKILL.md +62 -0
- package/assets/skills/deps/SKILL.md +66 -0
- package/assets/skills/e2e/SKILL.md +68 -0
- package/assets/skills/eng-spec/SKILL.md +93 -0
- package/assets/skills/envcheck/SKILL.md +65 -0
- package/assets/skills/explain/SKILL.md +52 -0
- package/assets/skills/landing-page-copy/SKILL.md +95 -0
- package/assets/skills/meeting-notes/SKILL.md +90 -0
- package/assets/skills/migration/SKILL.md +61 -0
- package/assets/skills/openpr/SKILL.md +143 -0
- package/assets/skills/opentodos/SKILL.md +79 -0
- package/assets/skills/perf/SKILL.md +58 -0
- package/assets/skills/prd/SKILL.md +71 -0
- package/assets/skills/readme/SKILL.md +55 -0
- package/assets/skills/rebase/SKILL.md +59 -0
- package/assets/skills/release/SKILL.md +64 -0
- package/assets/skills/release-plan/SKILL.md +107 -0
- package/assets/skills/requirements/SKILL.md +77 -0
- package/assets/skills/seo-brief/SKILL.md +88 -0
- package/assets/skills/standup/SKILL.md +48 -0
- package/assets/skills/storecontext/SKILL.md +76 -0
- package/assets/skills/summary/SKILL.md +72 -0
- package/assets/skills/test/SKILL.md +55 -0
- package/assets/skills/testcoverage/SKILL.md +57 -0
- package/assets/skills/todo/SKILL.md +84 -0
- package/assets/templates/DECISION_RECORD_TEMPLATE.md +59 -0
- package/assets/templates/ENG_SPEC_TEMPLATE.md +84 -0
- package/assets/templates/PRD_TEMPLATE.md +72 -0
- package/assets/templates/PROJECT_INDEX_TEMPLATE.md +65 -0
- package/assets/templates/WEEKLY_REVIEW_TEMPLATE.md +57 -0
- package/assets/vault/README.md +34 -0
- package/assets/vault/_index.md +27 -0
- package/dist/bin.js +888 -0
- package/dist/bin.js.map +1 -0
- package/package.json +60 -0
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: test
|
|
3
|
+
description: "Generate unit tests for code. Use when the user says /test, asks to write tests, create test cases, add unit tests, or test a function/class/module. Triggers: test, unit test, write tests, add tests, test cases, spec, jest, pytest, mocha, vitest."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Unit Test Generator
|
|
7
|
+
|
|
8
|
+
Generate comprehensive unit tests for code.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
|
|
12
|
+
1. **Detect the testing ecosystem:**
|
|
13
|
+
- Check for existing test config: `jest.config.*`, `vitest.config.*`, `pytest.ini`, `pyproject.toml [tool.pytest]`, `Cargo.toml`, `.rspec`, `go test`.
|
|
14
|
+
- Check for existing test files to match patterns and conventions.
|
|
15
|
+
- Identify the test runner, assertion library, and mocking framework in use.
|
|
16
|
+
|
|
17
|
+
2. **Analyze the target code:**
|
|
18
|
+
- Read the function/class/module to test.
|
|
19
|
+
- Identify: inputs, outputs, side effects, dependencies, edge cases, error paths.
|
|
20
|
+
- Map out the code paths (happy path, error paths, boundary conditions).
|
|
21
|
+
|
|
22
|
+
3. **Generate tests following the project's patterns:**
|
|
23
|
+
- Match existing file naming: `*.test.ts`, `*_test.go`, `test_*.py`, `*_spec.rb`, etc.
|
|
24
|
+
- Match existing directory structure (`__tests__/`, `tests/`, co-located, etc.).
|
|
25
|
+
- Use the same assertion style and patterns as existing tests.
|
|
26
|
+
|
|
27
|
+
4. **Write tests covering:**
|
|
28
|
+
|
|
29
|
+
### Test Categories
|
|
30
|
+
|
|
31
|
+
| Category | What to test |
|
|
32
|
+
|----------|-------------|
|
|
33
|
+
| **Happy path** | Normal inputs produce expected outputs |
|
|
34
|
+
| **Edge cases** | Empty inputs, zero, null/undefined, max values, single element |
|
|
35
|
+
| **Error handling** | Invalid inputs throw/return appropriate errors |
|
|
36
|
+
| **Boundary values** | Min, max, off-by-one, type boundaries |
|
|
37
|
+
| **State changes** | Side effects, mutations, event emissions |
|
|
38
|
+
| **Async behavior** | Promises, callbacks, timeouts (if applicable) |
|
|
39
|
+
|
|
40
|
+
5. **Structure each test with AAA pattern:**
|
|
41
|
+
- **Arrange** — set up preconditions and inputs.
|
|
42
|
+
- **Act** — execute the code under test.
|
|
43
|
+
- **Assert** — verify the expected outcome.
|
|
44
|
+
|
|
45
|
+
6. **Run the tests** to ensure they pass.
|
|
46
|
+
|
|
47
|
+
## Guidelines
|
|
48
|
+
|
|
49
|
+
- Tests should be independent — no shared mutable state between tests.
|
|
50
|
+
- Use descriptive test names that explain the scenario: `"returns empty array when input is empty"`.
|
|
51
|
+
- Mock external dependencies (APIs, databases, file system) but not the code under test.
|
|
52
|
+
- Prefer `toEqual` deep comparison over `toBe` reference comparison for objects.
|
|
53
|
+
- If the code is untestable, suggest refactoring to improve testability.
|
|
54
|
+
- Don't test implementation details — test behavior and public interfaces.
|
|
55
|
+
- Include at least one negative test (what should NOT happen).
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: testcoverage
|
|
3
|
+
description: "Analyze test coverage and identify gaps. Use when the user says /testcoverage, asks about test coverage, wants to improve coverage, find untested code, or reach a coverage target. Triggers: test coverage, coverage report, untested code, coverage gap, coverage target, uncovered lines, branch coverage."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Test Coverage Analyzer
|
|
7
|
+
|
|
8
|
+
Analyze test coverage and generate tests to fill gaps.
|
|
9
|
+
|
|
10
|
+
## Workflow
|
|
11
|
+
|
|
12
|
+
1. **Run coverage analysis:**
|
|
13
|
+
- Detect the test framework and run with coverage enabled:
|
|
14
|
+
- **JS/TS**: `npx jest --coverage` or `npx vitest --coverage` or `npx nyc mocha`
|
|
15
|
+
- **Python**: `pytest --cov=<package> --cov-report=term-missing`
|
|
16
|
+
- **Go**: `go test -coverprofile=coverage.out ./... && go tool cover -func=coverage.out`
|
|
17
|
+
- **Rust**: `cargo tarpaulin` or `cargo llvm-cov`
|
|
18
|
+
- Parse the coverage output.
|
|
19
|
+
|
|
20
|
+
2. **Analyze coverage gaps:**
|
|
21
|
+
- Identify files with lowest coverage.
|
|
22
|
+
- Identify uncovered lines and branches.
|
|
23
|
+
- Categorize gaps:
|
|
24
|
+
- **Critical**: Business logic, data validation, security checks.
|
|
25
|
+
- **Important**: Error handling, edge cases.
|
|
26
|
+
- **Low priority**: Logging, formatting, simple getters/setters.
|
|
27
|
+
|
|
28
|
+
3. **Present a coverage report:**
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
Coverage Summary: XX.X% (target: YY%)
|
|
32
|
+
|
|
33
|
+
Critical Gaps:
|
|
34
|
+
src/auth/login.ts 45% — lines 23-40, 67-89 (authentication logic)
|
|
35
|
+
src/api/payments.ts 38% — lines 12-35 (payment processing)
|
|
36
|
+
|
|
37
|
+
Important Gaps:
|
|
38
|
+
src/utils/validator.ts 62% — lines 44-58 (error handling)
|
|
39
|
+
|
|
40
|
+
Files at 100%: 12/30
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
4. **Generate tests for the highest-priority gaps:**
|
|
44
|
+
- Start with critical business logic.
|
|
45
|
+
- Focus on untested branches and error paths.
|
|
46
|
+
- Follow the project's existing test patterns.
|
|
47
|
+
|
|
48
|
+
5. **Re-run coverage to verify improvement.**
|
|
49
|
+
|
|
50
|
+
## Guidelines
|
|
51
|
+
|
|
52
|
+
- Focus on meaningful coverage, not just hitting a number.
|
|
53
|
+
- 100% coverage doesn't mean bug-free — test quality matters more than quantity.
|
|
54
|
+
- Prioritize branch coverage over line coverage.
|
|
55
|
+
- Don't test trivially obvious code just for the coverage number.
|
|
56
|
+
- If coverage tooling isn't set up, help configure it first.
|
|
57
|
+
- Consider setting up coverage thresholds in CI config if not already present.
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: todo
|
|
3
|
+
description: "Break down a project into actionable tasks. Use when the user says /todo, asks to create a task breakdown, decompose a feature into tasks, or plan work items. Triggers: todo, task breakdown, break down, decompose, work items, sprint planning, task list."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Task Breakdown
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
|
|
10
|
+
Decompose a project, feature, or initiative into actionable, well-defined tasks. Produce a structured checklist that a team can immediately pick up and work from, with clear priorities, effort estimates, and dependencies.
|
|
11
|
+
|
|
12
|
+
## When to Use
|
|
13
|
+
|
|
14
|
+
- Breaking down a feature or project into sprint-ready work items
|
|
15
|
+
- Creating a personal task list from a broad goal
|
|
16
|
+
- Estimating effort and identifying the critical path for a body of work
|
|
17
|
+
|
|
18
|
+
## Inputs
|
|
19
|
+
|
|
20
|
+
- **Work description**: The feature, project, or goal to decompose
|
|
21
|
+
- **Scope constraints**: Any boundaries on what to include or exclude (optional)
|
|
22
|
+
- **Team context**: Team size, roles, skill sets (optional)
|
|
23
|
+
- **Timeline**: Target completion date or sprint length (optional)
|
|
24
|
+
|
|
25
|
+
## Output Format
|
|
26
|
+
|
|
27
|
+
Produce a markdown document with the following structure:
|
|
28
|
+
|
|
29
|
+
### 1. Objective
|
|
30
|
+
One sentence stating what "done" looks like for this body of work.
|
|
31
|
+
|
|
32
|
+
### 2. Task List
|
|
33
|
+
|
|
34
|
+
For each task, use this checklist format:
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
- [ ] **Task title**
|
|
38
|
+
- Description: What needs to be done (1-2 sentences)
|
|
39
|
+
- Priority: P0 / P1 / P2
|
|
40
|
+
- Effort: S (< 2h) / M (2-8h) / L (1-3d) / XL (3-5d)
|
|
41
|
+
- Dependencies: List any tasks that must complete first
|
|
42
|
+
- Acceptance criteria: How to verify this task is done
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Group tasks into logical phases or categories using H3 headers.
|
|
46
|
+
|
|
47
|
+
### 3. Dependency Graph
|
|
48
|
+
A text summary of the critical path: which tasks block others and what can be parallelized.
|
|
49
|
+
|
|
50
|
+
### 4. Effort Summary
|
|
51
|
+
A quick table:
|
|
52
|
+
|
|
53
|
+
| Priority | Count | Total Effort |
|
|
54
|
+
|----------|-------|--------------|
|
|
55
|
+
| P0 | | |
|
|
56
|
+
| P1 | | |
|
|
57
|
+
| P2 | | |
|
|
58
|
+
|
|
59
|
+
### 5. Risks and Blockers
|
|
60
|
+
List anything that could delay or prevent completion.
|
|
61
|
+
|
|
62
|
+
## Example
|
|
63
|
+
|
|
64
|
+
**Input**: "Break down the work to add dark mode to our web app."
|
|
65
|
+
|
|
66
|
+
**Output**:
|
|
67
|
+
- Objective: Users can toggle between light and dark themes across all pages.
|
|
68
|
+
- Tasks grouped into phases:
|
|
69
|
+
- **Design**: Audit existing color tokens, define dark palette, update design system
|
|
70
|
+
- **Infrastructure**: Implement theme provider, add user preference storage, set up CSS variable system
|
|
71
|
+
- **Implementation**: Update core components, update page layouts, handle third-party widget theming
|
|
72
|
+
- **Testing**: Visual regression tests, accessibility contrast checks, cross-browser testing
|
|
73
|
+
- **Rollout**: Feature flag setup, beta rollout, documentation update
|
|
74
|
+
- Dependency graph showing design must precede implementation, infrastructure can parallel with design
|
|
75
|
+
- Effort summary showing total estimated work
|
|
76
|
+
|
|
77
|
+
## Guidelines
|
|
78
|
+
|
|
79
|
+
- Make each task small enough to complete in one sitting (aim for S or M when possible)
|
|
80
|
+
- Every task should have a clear "done" state -- no vague tasks like "work on styling"
|
|
81
|
+
- Order tasks within each phase by dependency, then priority
|
|
82
|
+
- Flag tasks that require specific expertise or access
|
|
83
|
+
- Include testing and documentation tasks -- they are real work
|
|
84
|
+
- If a task is XL, consider whether it should be broken down further
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# ADR-NNN: [Short Title of Decision]
|
|
2
|
+
|
|
3
|
+
**Status:** Proposed | Accepted | Deprecated | Superseded
|
|
4
|
+
**Date:** [YYYY-MM-DD]
|
|
5
|
+
**Decision Makers:** [List names or roles]
|
|
6
|
+
**Supersedes:** [ADR-XXX, if applicable]
|
|
7
|
+
**Superseded by:** [ADR-XXX, if applicable]
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Context
|
|
12
|
+
|
|
13
|
+
*What is the issue or situation that motivates this decision? Include relevant technical, business, or organizational constraints. Link to related documents or discussions.*
|
|
14
|
+
|
|
15
|
+
## Decision
|
|
16
|
+
|
|
17
|
+
*State the decision clearly and directly. Use active voice: "We will..." or "The system will..."*
|
|
18
|
+
|
|
19
|
+
## Consequences
|
|
20
|
+
|
|
21
|
+
### Positive
|
|
22
|
+
|
|
23
|
+
*Benefits and improvements resulting from this decision.*
|
|
24
|
+
|
|
25
|
+
1.
|
|
26
|
+
|
|
27
|
+
### Negative
|
|
28
|
+
|
|
29
|
+
*Trade-offs, costs, or risks introduced by this decision.*
|
|
30
|
+
|
|
31
|
+
1.
|
|
32
|
+
|
|
33
|
+
### Neutral
|
|
34
|
+
|
|
35
|
+
*Side effects that are neither clearly positive nor negative, but worth noting.*
|
|
36
|
+
|
|
37
|
+
1.
|
|
38
|
+
|
|
39
|
+
## Alternatives Considered
|
|
40
|
+
|
|
41
|
+
### Alternative 1: [Name]
|
|
42
|
+
|
|
43
|
+
*Brief description of the alternative approach.*
|
|
44
|
+
|
|
45
|
+
- **Pros:** [advantages]
|
|
46
|
+
- **Cons:** [disadvantages]
|
|
47
|
+
- **Reason rejected:** [why this was not chosen]
|
|
48
|
+
|
|
49
|
+
### Alternative 2: [Name]
|
|
50
|
+
|
|
51
|
+
*Brief description of the alternative approach.*
|
|
52
|
+
|
|
53
|
+
- **Pros:** [advantages]
|
|
54
|
+
- **Cons:** [disadvantages]
|
|
55
|
+
- **Reason rejected:** [why this was not chosen]
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
*To propose a new ADR, copy this template and assign the next available number. Update the status as the decision progresses through review.*
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# [Feature Name]: Engineering Specification
|
|
2
|
+
|
|
3
|
+
**Status:** Draft
|
|
4
|
+
**Author:** [Your Name]
|
|
5
|
+
**Date:** [YYYY-MM-DD]
|
|
6
|
+
**PRD Link:** [Link to related PRD]
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Overview
|
|
11
|
+
|
|
12
|
+
*High-level summary of what is being built and why. Keep to 2-3 sentences.*
|
|
13
|
+
|
|
14
|
+
## Architecture
|
|
15
|
+
|
|
16
|
+
*Describe the system design. Include a diagram if helpful (e.g., Mermaid, ASCII).*
|
|
17
|
+
|
|
18
|
+
### Components
|
|
19
|
+
|
|
20
|
+
*List the major components or services involved and their responsibilities.*
|
|
21
|
+
|
|
22
|
+
- **Component A** -- [responsibility]
|
|
23
|
+
- **Component B** -- [responsibility]
|
|
24
|
+
|
|
25
|
+
### Dependencies
|
|
26
|
+
|
|
27
|
+
*External services, libraries, or systems this design depends on.*
|
|
28
|
+
|
|
29
|
+
1.
|
|
30
|
+
|
|
31
|
+
## Data Model
|
|
32
|
+
|
|
33
|
+
*Define new or modified data structures, database tables, or schemas.*
|
|
34
|
+
|
|
35
|
+
```
|
|
36
|
+
Table/Model Name
|
|
37
|
+
-----------------
|
|
38
|
+
field_name type constraints
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
*Note any migrations required.*
|
|
42
|
+
|
|
43
|
+
## API Design
|
|
44
|
+
|
|
45
|
+
*Define new or modified endpoints, RPCs, or interfaces.*
|
|
46
|
+
|
|
47
|
+
### `METHOD /path`
|
|
48
|
+
|
|
49
|
+
- **Request:** describe body/params
|
|
50
|
+
- **Response:** describe shape
|
|
51
|
+
- **Errors:** list error codes and meanings
|
|
52
|
+
|
|
53
|
+
## Error Handling
|
|
54
|
+
|
|
55
|
+
*How will the system handle failures? Cover retries, fallbacks, and user-facing errors.*
|
|
56
|
+
|
|
57
|
+
| Error Scenario | Handling Strategy |
|
|
58
|
+
|---------------|-------------------|
|
|
59
|
+
| | |
|
|
60
|
+
|
|
61
|
+
## Testing Strategy
|
|
62
|
+
|
|
63
|
+
*Describe your approach to validating this work.*
|
|
64
|
+
|
|
65
|
+
- **Unit tests:** [scope and coverage targets]
|
|
66
|
+
- **Integration tests:** [what interactions are tested]
|
|
67
|
+
- **Manual/QA testing:** [key scenarios to verify]
|
|
68
|
+
|
|
69
|
+
## Rollout Plan
|
|
70
|
+
|
|
71
|
+
*How will this be deployed? Include feature flags, phased rollout, or canary steps.*
|
|
72
|
+
|
|
73
|
+
1. **Phase 1:** [description]
|
|
74
|
+
2. **Phase 2:** [description]
|
|
75
|
+
|
|
76
|
+
### Rollback Plan
|
|
77
|
+
|
|
78
|
+
*Steps to revert if something goes wrong.*
|
|
79
|
+
|
|
80
|
+
## Open Questions
|
|
81
|
+
|
|
82
|
+
| # | Question | Owner | Status |
|
|
83
|
+
|---|----------|-------|--------|
|
|
84
|
+
| 1 | | | |
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# [Product Name]: Product Requirements Document
|
|
2
|
+
|
|
3
|
+
**Status:** Draft
|
|
4
|
+
**Author:** [Your Name]
|
|
5
|
+
**Date:** [YYYY-MM-DD]
|
|
6
|
+
**Reviewers:** [List reviewers]
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Problem Statement
|
|
11
|
+
|
|
12
|
+
*Describe the problem you are solving. Who experiences it, how often, and what is the impact?*
|
|
13
|
+
|
|
14
|
+
## Goals & Non-Goals
|
|
15
|
+
|
|
16
|
+
### Goals
|
|
17
|
+
|
|
18
|
+
*What this project aims to achieve. Be specific and measurable.*
|
|
19
|
+
|
|
20
|
+
1.
|
|
21
|
+
|
|
22
|
+
### Non-Goals
|
|
23
|
+
|
|
24
|
+
*What this project explicitly will not address. This is just as important as goals.*
|
|
25
|
+
|
|
26
|
+
1.
|
|
27
|
+
|
|
28
|
+
## User Stories
|
|
29
|
+
|
|
30
|
+
*Describe the key user interactions in "As a [role], I want [action], so that [benefit]" format.*
|
|
31
|
+
|
|
32
|
+
1. As a ..., I want ..., so that ...
|
|
33
|
+
|
|
34
|
+
## Functional Requirements
|
|
35
|
+
|
|
36
|
+
*What the system must do. Number each requirement for easy reference.*
|
|
37
|
+
|
|
38
|
+
| ID | Requirement | Priority (P0/P1/P2) |
|
|
39
|
+
|----|-------------|----------------------|
|
|
40
|
+
| FR-1 | | |
|
|
41
|
+
| FR-2 | | |
|
|
42
|
+
|
|
43
|
+
## Non-Functional Requirements
|
|
44
|
+
|
|
45
|
+
*Performance, security, scalability, accessibility, and other quality attributes.*
|
|
46
|
+
|
|
47
|
+
| ID | Requirement | Target |
|
|
48
|
+
|----|-------------|--------|
|
|
49
|
+
| NFR-1 | | |
|
|
50
|
+
| NFR-2 | | |
|
|
51
|
+
|
|
52
|
+
## Success Metrics
|
|
53
|
+
|
|
54
|
+
*How will you know this project succeeded? Define measurable outcomes.*
|
|
55
|
+
|
|
56
|
+
| Metric | Current Baseline | Target | Measurement Method |
|
|
57
|
+
|--------|-----------------|--------|-------------------|
|
|
58
|
+
| | | | |
|
|
59
|
+
|
|
60
|
+
## Out of Scope
|
|
61
|
+
|
|
62
|
+
*Items deliberately excluded from this effort. Reference future work if applicable.*
|
|
63
|
+
|
|
64
|
+
1.
|
|
65
|
+
|
|
66
|
+
## Open Questions
|
|
67
|
+
|
|
68
|
+
*Unresolved questions that need answers before or during implementation.*
|
|
69
|
+
|
|
70
|
+
| # | Question | Owner | Status |
|
|
71
|
+
|---|----------|-------|--------|
|
|
72
|
+
| 1 | | | |
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# [Project Name]
|
|
2
|
+
|
|
3
|
+
*[One-sentence description of what this project does and who it serves.]*
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Quick Links
|
|
8
|
+
|
|
9
|
+
- **Repository:** [link]
|
|
10
|
+
- **CI/CD:** [link]
|
|
11
|
+
- **Production:** [link]
|
|
12
|
+
- **Monitoring/Dashboard:** [link]
|
|
13
|
+
- **Issue Tracker:** [link]
|
|
14
|
+
|
|
15
|
+
## Team
|
|
16
|
+
|
|
17
|
+
| Role | Name | Contact |
|
|
18
|
+
|------|------|---------|
|
|
19
|
+
| Tech Lead | | |
|
|
20
|
+
| Product Owner | | |
|
|
21
|
+
| Engineers | | |
|
|
22
|
+
| Designer | | |
|
|
23
|
+
|
|
24
|
+
## Tech Stack
|
|
25
|
+
|
|
26
|
+
*List the primary languages, frameworks, infrastructure, and tools.*
|
|
27
|
+
|
|
28
|
+
| Layer | Technology |
|
|
29
|
+
|-------|-----------|
|
|
30
|
+
| Frontend | |
|
|
31
|
+
| Backend | |
|
|
32
|
+
| Database | |
|
|
33
|
+
| Infrastructure | |
|
|
34
|
+
| CI/CD | |
|
|
35
|
+
|
|
36
|
+
## Key Documents
|
|
37
|
+
|
|
38
|
+
*Link to living documents that drive this project.*
|
|
39
|
+
|
|
40
|
+
- [PRD](link) -- product requirements
|
|
41
|
+
- [Engineering Spec](link) -- technical design
|
|
42
|
+
- [ADRs](link) -- architectural decision records
|
|
43
|
+
- [Runbook](link) -- operational procedures
|
|
44
|
+
|
|
45
|
+
## Architecture Overview
|
|
46
|
+
|
|
47
|
+
*Brief description of how the system is structured. Include a diagram link or inline diagram if available.*
|
|
48
|
+
|
|
49
|
+
## Getting Started
|
|
50
|
+
|
|
51
|
+
*Steps for a new contributor to get the project running locally.*
|
|
52
|
+
|
|
53
|
+
1. Clone the repository
|
|
54
|
+
2. Install dependencies: `[command]`
|
|
55
|
+
3. Set up environment: `cp .env.example .env`
|
|
56
|
+
4. Run locally: `[command]`
|
|
57
|
+
5. Run tests: `[command]`
|
|
58
|
+
|
|
59
|
+
## Current Status
|
|
60
|
+
|
|
61
|
+
*What phase is the project in? Note any active workstreams or upcoming milestones.*
|
|
62
|
+
|
|
63
|
+
| Milestone | Target Date | Status |
|
|
64
|
+
|-----------|-------------|--------|
|
|
65
|
+
| | | |
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# Weekly Review
|
|
2
|
+
|
|
3
|
+
**Week Of:** [YYYY-MM-DD]
|
|
4
|
+
**Author:** [Your Name]
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Accomplishments
|
|
9
|
+
|
|
10
|
+
*What was completed this week? Link to PRs, tickets, or documents where relevant.*
|
|
11
|
+
|
|
12
|
+
- [ ]
|
|
13
|
+
- [ ]
|
|
14
|
+
|
|
15
|
+
## In Progress
|
|
16
|
+
|
|
17
|
+
*Work that is actively underway but not yet complete. Note expected completion.*
|
|
18
|
+
|
|
19
|
+
| Item | Status | ETA |
|
|
20
|
+
|------|--------|-----|
|
|
21
|
+
| | | |
|
|
22
|
+
|
|
23
|
+
## Blocked
|
|
24
|
+
|
|
25
|
+
*Items that cannot proceed. Identify the blocker and who can resolve it.*
|
|
26
|
+
|
|
27
|
+
| Item | Blocker | Owner |
|
|
28
|
+
|------|---------|-------|
|
|
29
|
+
| | | |
|
|
30
|
+
|
|
31
|
+
## Key Metrics
|
|
32
|
+
|
|
33
|
+
*Relevant numbers for the week: deploys, incidents, velocity, etc.*
|
|
34
|
+
|
|
35
|
+
| Metric | This Week | Last Week | Trend |
|
|
36
|
+
|--------|-----------|-----------|-------|
|
|
37
|
+
| | | | |
|
|
38
|
+
|
|
39
|
+
## Learnings
|
|
40
|
+
|
|
41
|
+
*What did you learn this week? Technical insights, process improvements, or retrospective notes.*
|
|
42
|
+
|
|
43
|
+
1.
|
|
44
|
+
|
|
45
|
+
## Next Week Priorities
|
|
46
|
+
|
|
47
|
+
*Top priorities for the coming week, ordered by importance.*
|
|
48
|
+
|
|
49
|
+
1.
|
|
50
|
+
2.
|
|
51
|
+
3.
|
|
52
|
+
|
|
53
|
+
## Notes
|
|
54
|
+
|
|
55
|
+
*Anything else worth capturing: upcoming PTO, schedule changes, shoutouts, risks.*
|
|
56
|
+
|
|
57
|
+
-
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Context Vault
|
|
2
|
+
|
|
3
|
+
This vault is a structured Markdown knowledge base for your project. It is designed to be readable and writable by both humans and AI tools.
|
|
4
|
+
|
|
5
|
+
## Folder Taxonomy
|
|
6
|
+
|
|
7
|
+
| Folder | Purpose |
|
|
8
|
+
|--------|---------|
|
|
9
|
+
| `00_inbox/` | Unsorted notes, quick captures, raw inputs |
|
|
10
|
+
| `01_specs/` | Requirements, PRDs, feature specs |
|
|
11
|
+
| `02_architecture/` | System design, technical specs, diagrams |
|
|
12
|
+
| `03_decisions/` | Architectural Decision Records (ADRs) |
|
|
13
|
+
| `04_knowledge/` | Reusable concepts, reference material, guides |
|
|
14
|
+
| `05_prompts/` | LLM prompts, prompt templates |
|
|
15
|
+
| `06_agents/` | Agent roles, rules, memory, configuration |
|
|
16
|
+
| `07_diagrams/` | Mermaid diagrams, visual references |
|
|
17
|
+
| `08_todos/` | Task lists, backlogs, sprint plans |
|
|
18
|
+
|
|
19
|
+
## Naming Conventions
|
|
20
|
+
|
|
21
|
+
- Use lowercase with hyphens: `my-feature-spec.md`
|
|
22
|
+
- Prefix with date when chronology matters: `2026-02-07-auth-decision.md`
|
|
23
|
+
- Keep filenames descriptive and specific
|
|
24
|
+
- One topic per file — keep documents small and composable
|
|
25
|
+
|
|
26
|
+
## File Format
|
|
27
|
+
|
|
28
|
+
- All files should be UTF-8 Markdown (`.md`)
|
|
29
|
+
- Start each file with a `# Title` heading
|
|
30
|
+
- Use relative Markdown links between documents: `[link text](../01_specs/feature.md)`
|
|
31
|
+
|
|
32
|
+
## Working with AI Tools
|
|
33
|
+
|
|
34
|
+
AI tools can freely read any file and create new `.md` files. Overwriting or deleting existing files requires explicit permission.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Project Index
|
|
2
|
+
|
|
3
|
+
> Navigation hub for your project context. Update this file as your project evolves.
|
|
4
|
+
|
|
5
|
+
## Quick Links
|
|
6
|
+
|
|
7
|
+
- [Vault README](./README.md)
|
|
8
|
+
|
|
9
|
+
## Specs & Requirements
|
|
10
|
+
|
|
11
|
+
<!-- Add links to specs as you create them -->
|
|
12
|
+
<!-- Example: - [Feature X PRD](./01_specs/feature-x-prd.md) -->
|
|
13
|
+
|
|
14
|
+
## Architecture
|
|
15
|
+
|
|
16
|
+
<!-- Add links to architecture docs -->
|
|
17
|
+
<!-- Example: - [System Overview](./02_architecture/system-overview.md) -->
|
|
18
|
+
|
|
19
|
+
## Decisions
|
|
20
|
+
|
|
21
|
+
<!-- Add links to ADRs -->
|
|
22
|
+
<!-- Example: - [ADR-001: Use PostgreSQL](./03_decisions/adr-001-use-postgresql.md) -->
|
|
23
|
+
|
|
24
|
+
## Active Tasks
|
|
25
|
+
|
|
26
|
+
<!-- Add links to current task lists -->
|
|
27
|
+
<!-- Example: - [Sprint 1 Tasks](./08_todos/sprint-1.md) -->
|