create-quiver 0.4.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/.github/ISSUE_TEMPLATE/bug_report.md +15 -0
- package/.github/ISSUE_TEMPLATE/feature_request.md +15 -0
- package/.github/pull_request_template.md +4 -0
- package/.github/workflows/ci.yml +74 -0
- package/CHANGELOG.md +24 -0
- package/CODE_OF_CONDUCT.md +12 -0
- package/CONTRIBUTING.md +15 -0
- package/LICENSE +21 -0
- package/README.md +118 -0
- package/README_FOR_AI.md +90 -0
- package/ROADMAP.md +20 -0
- package/SECURITY.md +12 -0
- package/TEMPLATE.md +108 -0
- package/bin/create-quiver.js +8 -0
- package/docs/CONTEXTO.md.template +45 -0
- package/docs/DOCUMENTATION_GUIDE.md.template +34 -0
- package/docs/GITFLOW_PR_GUIDE.md.template +52 -0
- package/docs/INDEX.md.template +41 -0
- package/docs/MOCK_DATA_GUIDE.md.template +31 -0
- package/docs/MULTI_AGENT_WORKFLOW.md.template +31 -0
- package/docs/STATUS.md.template +26 -0
- package/docs/SUPPORT_MATRIX.md.template +31 -0
- package/docs/TESTING_GUIDE_FOR_AI.md.template +42 -0
- package/docs/TROUBLESHOOTING.md.template +70 -0
- package/docs/UI_STANDARDS.md.template +31 -0
- package/docs/WORKFLOW.md.template +56 -0
- package/docs/ai/LESSONS.md.template +24 -0
- package/docs/ai/PRINCIPLES.md +25 -0
- package/docs/ai/RULES.yaml +33 -0
- package/i18n/es/README.md +15 -0
- package/i18n/es/README_FOR_AI.md +6 -0
- package/i18n/es/TEMPLATE.md +18 -0
- package/i18n/es/docs/CONTEXTO.md.template +9 -0
- package/i18n/es/docs/DOCUMENTATION_GUIDE.md.template +4 -0
- package/i18n/es/docs/GITFLOW_PR_GUIDE.md.template +4 -0
- package/i18n/es/docs/INDEX.md.template +10 -0
- package/i18n/es/docs/MOCK_DATA_GUIDE.md.template +4 -0
- package/i18n/es/docs/MULTI_AGENT_WORKFLOW.md.template +4 -0
- package/i18n/es/docs/STATUS.md.template +9 -0
- package/i18n/es/docs/TESTING_GUIDE_FOR_AI.md.template +7 -0
- package/i18n/es/docs/UI_STANDARDS.md.template +4 -0
- package/i18n/es/docs/WORKFLOW.md.template +6 -0
- package/i18n/es/docs/ai/LESSONS.md.template +3 -0
- package/i18n/es/docs/ai/PRINCIPLES.md +7 -0
- package/i18n/es/docs/ai/RULES.yaml +7 -0
- package/package.json +19 -0
- package/package.template.json +10 -0
- package/scripts/check-pr-readiness.sh +138 -0
- package/scripts/check-scope.sh +150 -0
- package/scripts/check-slice-readiness.sh +319 -0
- package/scripts/cleanup-slice.sh +177 -0
- package/scripts/init-docs.sh +368 -0
- package/scripts/migrate-project.sh +218 -0
- package/scripts/package-quiver.sh +124 -0
- package/scripts/refresh-active-slices.sh +232 -0
- package/scripts/release-quiver.sh +77 -0
- package/scripts/start-slice.sh +429 -0
- package/specs/[project-name]/EVIDENCE_REPORT.md.template +15 -0
- package/specs/[project-name]/SPEC.md.template +39 -0
- package/specs/[project-name]/STATUS.md.template +22 -0
- package/specs/[project-name]/slices/pr.md.template +97 -0
- package/specs/[project-name]/slices/slice-template/slice.json +69 -0
- package/specs/quiver-v05-readme-adoption-contract/EVIDENCE_REPORT.md +21 -0
- package/specs/quiver-v05-readme-adoption-contract/SPEC.md +40 -0
- package/specs/quiver-v05-readme-adoption-contract/STATUS.md +24 -0
- package/specs/quiver-v05-readme-adoption-contract/slices/slice-01-readme-adoption-contract/slice.json +68 -0
- package/specs/quiver-v06-release-readiness/EVIDENCE_REPORT.md +23 -0
- package/specs/quiver-v06-release-readiness/SPEC.md +40 -0
- package/specs/quiver-v06-release-readiness/STATUS.md +24 -0
- package/specs/quiver-v06-release-readiness/slices/slice-01-first-npm-release-readiness/slice.json +71 -0
- package/src/create-quiver/index.js +329 -0
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# {{PROJECT_NAME}} Documentation Index
|
|
2
|
+
|
|
3
|
+
**Last updated:** {{FECHA}}
|
|
4
|
+
|
|
5
|
+
## Start Here
|
|
6
|
+
|
|
7
|
+
- **Context** - `./CONTEXTO.md`
|
|
8
|
+
- **Workflow** - `./WORKFLOW.md`
|
|
9
|
+
- **Support Matrix** - `./SUPPORT_MATRIX.md`
|
|
10
|
+
- **Troubleshooting** - `./TROUBLESHOOTING.md`
|
|
11
|
+
- **Multi-agent workflow** - `./MULTI_AGENT_WORKFLOW.md`
|
|
12
|
+
|
|
13
|
+
## AI Configuration
|
|
14
|
+
|
|
15
|
+
- **Principles** - `./ai/PRINCIPLES.md`
|
|
16
|
+
- **Rules** - `./ai/RULES.yaml`
|
|
17
|
+
- **Lessons** - `./ai/LESSONS.md`
|
|
18
|
+
|
|
19
|
+
## Optional Docs
|
|
20
|
+
|
|
21
|
+
- **Status** - `./STATUS.md`
|
|
22
|
+
- **Specs** - `../specs/{{PROJECT_SLUG}}/`
|
|
23
|
+
- **Tools** - `./tools/`
|
|
24
|
+
- **Archive** - `./archive/`
|
|
25
|
+
|
|
26
|
+
## Directory Layout
|
|
27
|
+
|
|
28
|
+
```text
|
|
29
|
+
docs/
|
|
30
|
+
├── INDEX.md
|
|
31
|
+
├── CONTEXTO.md
|
|
32
|
+
├── STATUS.md
|
|
33
|
+
├── WORKFLOW.md
|
|
34
|
+
├── SUPPORT_MATRIX.md
|
|
35
|
+
├── TROUBLESHOOTING.md
|
|
36
|
+
├── MULTI_AGENT_WORKFLOW.md
|
|
37
|
+
├── ai/
|
|
38
|
+
├── api/
|
|
39
|
+
├── tools/
|
|
40
|
+
└── archive/
|
|
41
|
+
```
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Mock Data Guide
|
|
2
|
+
|
|
3
|
+
**Purpose:** Define a simple mock-data approach for projects that do not have a real backend yet.
|
|
4
|
+
|
|
5
|
+
## What This Covers
|
|
6
|
+
|
|
7
|
+
- Mock entities
|
|
8
|
+
- Stub API responses
|
|
9
|
+
- Example hooks and components
|
|
10
|
+
|
|
11
|
+
## Recommended Structure
|
|
12
|
+
|
|
13
|
+
```text
|
|
14
|
+
types/
|
|
15
|
+
data/mocks/
|
|
16
|
+
lib/api/
|
|
17
|
+
hooks/
|
|
18
|
+
app/api/
|
|
19
|
+
components/
|
|
20
|
+
docs/api/
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## When to Use Mocks
|
|
24
|
+
|
|
25
|
+
- The backend is not ready
|
|
26
|
+
- You need UI progress without waiting for APIs
|
|
27
|
+
- You need deterministic test data
|
|
28
|
+
|
|
29
|
+
## Notes
|
|
30
|
+
|
|
31
|
+
Keep mock data realistic and small. Do not duplicate production-only logic here.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Multi-Agent Workflow
|
|
2
|
+
|
|
3
|
+
**Date:** {{FECHA}}
|
|
4
|
+
|
|
5
|
+
Use multiple agents only when the work can be split by independent ownership and merged without conflict.
|
|
6
|
+
|
|
7
|
+
## When to Use
|
|
8
|
+
|
|
9
|
+
- Large file exploration
|
|
10
|
+
- Independent documentation updates
|
|
11
|
+
- Separate feature slices with disjoint write sets
|
|
12
|
+
|
|
13
|
+
## When Not to Use
|
|
14
|
+
|
|
15
|
+
- One small task
|
|
16
|
+
- Shared central files
|
|
17
|
+
- A task where the next step depends on one immediate result
|
|
18
|
+
|
|
19
|
+
## Ownership Rule
|
|
20
|
+
|
|
21
|
+
Each worker must own its files or output set. If two workers need the same file, the task is not ready for parallel execution.
|
|
22
|
+
|
|
23
|
+
## Delivery Rule
|
|
24
|
+
|
|
25
|
+
A valid worker delivery must include:
|
|
26
|
+
|
|
27
|
+
- concrete changes or findings
|
|
28
|
+
- files touched
|
|
29
|
+
- validation performed
|
|
30
|
+
- evidence
|
|
31
|
+
- open risks
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# {{PROJECT_NAME}} Status
|
|
2
|
+
|
|
3
|
+
**Last updated:** {{FECHA}}
|
|
4
|
+
**Next update:** {{FECHA_PROXIMA}}
|
|
5
|
+
|
|
6
|
+
## Overall Status
|
|
7
|
+
|
|
8
|
+
- Progress: {{X}}% complete
|
|
9
|
+
- Current phase: {{FASE}}
|
|
10
|
+
- Next milestone: [Description]
|
|
11
|
+
|
|
12
|
+
## Slice Summary
|
|
13
|
+
|
|
14
|
+
| Slice | Title | Status | Progress | Spec |
|
|
15
|
+
|-------|-------|--------|----------|------|
|
|
16
|
+
| 01 | [Name] | Done | 100% | [link](../specs/{{PROJECT_SLUG}}/slices/slice-01/slice.json) |
|
|
17
|
+
|
|
18
|
+
## Blockers
|
|
19
|
+
|
|
20
|
+
| Blocker | Impact | Mitigation |
|
|
21
|
+
|---------|--------|------------|
|
|
22
|
+
| - | - | - |
|
|
23
|
+
|
|
24
|
+
## Notes
|
|
25
|
+
|
|
26
|
+
- Update this file after each completed slice.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Support Matrix
|
|
2
|
+
|
|
3
|
+
**Project:** {{PROJECT_NAME}}
|
|
4
|
+
**Last updated:** {{FECHA}}
|
|
5
|
+
|
|
6
|
+
Quiver is intentionally opinionated about the first-run environment. If your setup falls outside this matrix, the bootstrap scripts may stop early by design.
|
|
7
|
+
|
|
8
|
+
## Supported Environments
|
|
9
|
+
|
|
10
|
+
| Area | Supported | Notes |
|
|
11
|
+
|------|-----------|-------|
|
|
12
|
+
| Operating systems | macOS and Linux | Windows is not supported in this workflow. |
|
|
13
|
+
| Git | Git 2.40+ | Must support worktrees and standard branch refs. |
|
|
14
|
+
| Node.js | Node 22.x LTS | Used for date handling and JSON validation. |
|
|
15
|
+
| Base branches | `develop` or `main` | Local base branches are preferred; `origin` is optional. |
|
|
16
|
+
| Worktree state | Clean worktree | Slice execution and PR checks expect no unrelated local changes. |
|
|
17
|
+
| Path handling | Canonical filesystem paths | Use the physical path to the repo and slice files, not a symlinked alias. |
|
|
18
|
+
|
|
19
|
+
## Remote Modes
|
|
20
|
+
|
|
21
|
+
| Mode | Supported | Notes |
|
|
22
|
+
|------|-----------|-------|
|
|
23
|
+
| Local base branch only | Yes | The bootstrap should still work when `origin` is unavailable. |
|
|
24
|
+
| Remote base branch available | Yes | `origin/develop` or `origin/main` can be used when present. |
|
|
25
|
+
| No base branch and no remote | No | Create or fetch a base branch before starting a slice. |
|
|
26
|
+
|
|
27
|
+
## What This Means
|
|
28
|
+
|
|
29
|
+
- You can bootstrap a slice on macOS or Linux without changing the scripts.
|
|
30
|
+
- You do not need a remote to begin work if a local base branch already exists.
|
|
31
|
+
- If the environment is outside the matrix, fix the machine first instead of working around the scripts.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Testing Guide for AI
|
|
2
|
+
|
|
3
|
+
**Date:** [YYYY-MM-DD]
|
|
4
|
+
**Purpose:** Define the testing process AI should follow for each slice.
|
|
5
|
+
|
|
6
|
+
## Testing Flow
|
|
7
|
+
|
|
8
|
+
1. Read the slice spec.
|
|
9
|
+
2. Implement the change.
|
|
10
|
+
3. Run validation commands.
|
|
11
|
+
4. Capture evidence.
|
|
12
|
+
5. If a bug is found, document it and create a fix slice if needed.
|
|
13
|
+
|
|
14
|
+
## Before Implementation
|
|
15
|
+
|
|
16
|
+
- Review `acceptance`
|
|
17
|
+
- Review `tests`
|
|
18
|
+
- Review `files`
|
|
19
|
+
|
|
20
|
+
## During Implementation
|
|
21
|
+
|
|
22
|
+
- Keep changes within scope
|
|
23
|
+
- Check syntax and linting early
|
|
24
|
+
- Capture intermediate evidence when useful
|
|
25
|
+
|
|
26
|
+
## After Implementation
|
|
27
|
+
|
|
28
|
+
- Run the slice validation gate
|
|
29
|
+
- Run the PR validation gate
|
|
30
|
+
- Store evidence in `test-results/`
|
|
31
|
+
|
|
32
|
+
## Evidence
|
|
33
|
+
|
|
34
|
+
- Logs
|
|
35
|
+
- Screenshots
|
|
36
|
+
- Diff output
|
|
37
|
+
|
|
38
|
+
## If Something Fails
|
|
39
|
+
|
|
40
|
+
1. Fix the issue.
|
|
41
|
+
2. Re-run validation.
|
|
42
|
+
3. Update the evidence.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Troubleshooting
|
|
2
|
+
|
|
3
|
+
**Project:** {{PROJECT_NAME}}
|
|
4
|
+
**Last updated:** {{FECHA}}
|
|
5
|
+
|
|
6
|
+
Use this guide when a first-run bootstrap or gate check fails. The recovery paths below follow the smoke-tested flows in this repository.
|
|
7
|
+
|
|
8
|
+
## Path Normalization Failure
|
|
9
|
+
|
|
10
|
+
### Symptom
|
|
11
|
+
|
|
12
|
+
- `start-slice.sh` rejects a slice that exists
|
|
13
|
+
- The repo path and the slice path differ only by a symlinked or canonicalized prefix
|
|
14
|
+
|
|
15
|
+
### Recovery
|
|
16
|
+
|
|
17
|
+
1. Re-run the command from the physical repo path.
|
|
18
|
+
2. Pass the slice path from the same filesystem view that the repo uses.
|
|
19
|
+
3. Avoid mixing `/tmp/...` and `/private/tmp/...` or other alias paths.
|
|
20
|
+
|
|
21
|
+
## Missing Base Branch
|
|
22
|
+
|
|
23
|
+
### Symptom
|
|
24
|
+
|
|
25
|
+
- `start-slice.sh` reports that it cannot find `develop` or `main`
|
|
26
|
+
- The repo has no local base branch and no usable remote ref
|
|
27
|
+
|
|
28
|
+
### Recovery
|
|
29
|
+
|
|
30
|
+
1. Create or fetch the base branch locally.
|
|
31
|
+
2. Re-run the slice bootstrap after `develop` or `main` is visible to git.
|
|
32
|
+
3. If the remote exists but is stale, fetch it before retrying.
|
|
33
|
+
|
|
34
|
+
## Remote Mode Issues
|
|
35
|
+
|
|
36
|
+
### Symptom
|
|
37
|
+
|
|
38
|
+
- The repository works locally but fails as soon as `origin` is removed
|
|
39
|
+
- The bootstrap assumes a remote exists even though the workflow should support local-only setup
|
|
40
|
+
|
|
41
|
+
### Recovery
|
|
42
|
+
|
|
43
|
+
1. Keep a local `develop` or `main` branch available.
|
|
44
|
+
2. Re-add the remote only if the workflow genuinely needs it.
|
|
45
|
+
3. Prefer the local base branch path when validating first-run behavior.
|
|
46
|
+
|
|
47
|
+
## Generated File Conflicts
|
|
48
|
+
|
|
49
|
+
### Symptom
|
|
50
|
+
|
|
51
|
+
- `init-docs.sh` or a slice bootstrap stops because a file already exists
|
|
52
|
+
- The generated project has a partially initialized docs tree
|
|
53
|
+
|
|
54
|
+
### Recovery
|
|
55
|
+
|
|
56
|
+
1. Check whether the target file is meant to be preserved.
|
|
57
|
+
2. Remove the conflicting generated file only if it is safe to regenerate.
|
|
58
|
+
3. Re-run the bootstrap after the docs tree is consistent again.
|
|
59
|
+
|
|
60
|
+
## Clean Worktree Failures
|
|
61
|
+
|
|
62
|
+
### Symptom
|
|
63
|
+
|
|
64
|
+
- `check-pr-readiness.sh` reports that the worktree is dirty
|
|
65
|
+
|
|
66
|
+
### Recovery
|
|
67
|
+
|
|
68
|
+
1. Commit or stash unrelated changes first.
|
|
69
|
+
2. Re-run the gate from the slice branch.
|
|
70
|
+
3. Make sure the PR body lives in `pr.md` beside the slice.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# UI Standards
|
|
2
|
+
|
|
3
|
+
**Version:** 1.0
|
|
4
|
+
**Last updated:** {{FECHA}}
|
|
5
|
+
|
|
6
|
+
## Principles
|
|
7
|
+
|
|
8
|
+
1. Consistency
|
|
9
|
+
2. Accessibility
|
|
10
|
+
3. Responsive layout
|
|
11
|
+
4. Performance
|
|
12
|
+
|
|
13
|
+
## Baseline Tokens
|
|
14
|
+
|
|
15
|
+
Use CSS variables or design tokens for:
|
|
16
|
+
|
|
17
|
+
- colors
|
|
18
|
+
- spacing
|
|
19
|
+
- typography
|
|
20
|
+
- radii
|
|
21
|
+
- shadows
|
|
22
|
+
|
|
23
|
+
## Interaction Rules
|
|
24
|
+
|
|
25
|
+
- Use clear focus states
|
|
26
|
+
- Use visible disabled states
|
|
27
|
+
- Keep hover and press feedback consistent
|
|
28
|
+
|
|
29
|
+
## Notes
|
|
30
|
+
|
|
31
|
+
If the project has no UI, delete this file from the generated project.
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Workflow
|
|
2
|
+
|
|
3
|
+
**Date:** {{FECHA}}
|
|
4
|
+
|
|
5
|
+
This document is the canonical implementation workflow for the project.
|
|
6
|
+
|
|
7
|
+
## Core Rules
|
|
8
|
+
|
|
9
|
+
- Do not implement without a slice.
|
|
10
|
+
- One slice maps to one commit.
|
|
11
|
+
- One spec maps to one PR.
|
|
12
|
+
- Slice numbering is local to each spec. Every spec starts at `slice-01`.
|
|
13
|
+
- The spec defines the plan; the slice defines the execution.
|
|
14
|
+
- No slice should enter execution until it is `ready`.
|
|
15
|
+
- The documentation PR establishes the workflow files before the first slice executes.
|
|
16
|
+
- The support matrix defines the supported OS, git, node, and remote modes.
|
|
17
|
+
- The troubleshooting guide explains the first-run recovery paths for common bootstrap failures.
|
|
18
|
+
|
|
19
|
+
## Planning
|
|
20
|
+
|
|
21
|
+
1. Triage the request.
|
|
22
|
+
2. Decide whether to create a new spec or reuse an existing one.
|
|
23
|
+
3. Split the work into slices.
|
|
24
|
+
4. Mark each slice `ready` before execution.
|
|
25
|
+
5. Open and merge the documentation PR before running the first slice bootstrap.
|
|
26
|
+
6. Read the support matrix and troubleshooting guide before the first slice if the environment is new or uncertain.
|
|
27
|
+
|
|
28
|
+
## Execution
|
|
29
|
+
|
|
30
|
+
1. Bootstrap the slice with `start-slice.sh`.
|
|
31
|
+
- The bootstrap step should work with canonical paths and a local base branch when `origin` is absent.
|
|
32
|
+
- Draft slices require `--allow-draft`; otherwise `start-slice.sh` exits before execution.
|
|
33
|
+
2. Implement only what the slice declares.
|
|
34
|
+
3. Make one commit for that slice.
|
|
35
|
+
4. Validate with `check-slice-readiness.sh`.
|
|
36
|
+
5. Write evidence.
|
|
37
|
+
6. Repeat for the next slice until the spec is complete.
|
|
38
|
+
7. Open one PR for the spec and use `check-pr-readiness.sh` as the pre-merge gate.
|
|
39
|
+
|
|
40
|
+
## Support Contract
|
|
41
|
+
|
|
42
|
+
- Support Matrix (`SUPPORT_MATRIX.md`) documents what is supported.
|
|
43
|
+
- Troubleshooting (`TROUBLESHOOTING.md`) documents how to recover when the first run fails.
|
|
44
|
+
- Keep both files linked from the root README and this workflow doc.
|
|
45
|
+
|
|
46
|
+
## Multi-Agent Rule
|
|
47
|
+
|
|
48
|
+
Use multiple agents only when the write sets do not overlap and the coordination cost is lower than the gain.
|
|
49
|
+
|
|
50
|
+
## References
|
|
51
|
+
|
|
52
|
+
- `GITFLOW_PR_GUIDE.md`
|
|
53
|
+
- `SUPPORT_MATRIX.md`
|
|
54
|
+
- `TROUBLESHOOTING.md`
|
|
55
|
+
- `MULTI_AGENT_WORKFLOW.md`
|
|
56
|
+
- `TESTING_GUIDE_FOR_AI.md`
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Lessons Learned
|
|
2
|
+
|
|
3
|
+
**Last updated:** {{FECHA}}
|
|
4
|
+
|
|
5
|
+
## [Lesson Title]
|
|
6
|
+
|
|
7
|
+
### Context
|
|
8
|
+
|
|
9
|
+
[What happened]
|
|
10
|
+
|
|
11
|
+
### What Worked
|
|
12
|
+
|
|
13
|
+
- [Item 1]
|
|
14
|
+
- [Item 2]
|
|
15
|
+
|
|
16
|
+
### What Did Not Work
|
|
17
|
+
|
|
18
|
+
- [Item 1]
|
|
19
|
+
- [Item 2]
|
|
20
|
+
|
|
21
|
+
### Next Time
|
|
22
|
+
|
|
23
|
+
- [Rule 1]
|
|
24
|
+
- [Rule 2]
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# AI Principles
|
|
2
|
+
|
|
3
|
+
**Last updated:** 2026-03-13
|
|
4
|
+
|
|
5
|
+
## 1. Privacy First
|
|
6
|
+
|
|
7
|
+
- Never log sensitive data.
|
|
8
|
+
- Never expose secrets in logs or errors.
|
|
9
|
+
- Always use environment variables for secrets.
|
|
10
|
+
|
|
11
|
+
## 2. Simple Is Better
|
|
12
|
+
|
|
13
|
+
- Choose the simplest solution that works.
|
|
14
|
+
- Avoid speculative abstractions.
|
|
15
|
+
- Prefer MVP-first implementation.
|
|
16
|
+
|
|
17
|
+
## 3. Test Before Commit
|
|
18
|
+
|
|
19
|
+
- Functional changes need tests or manual verification.
|
|
20
|
+
- Do not commit a change that you cannot validate.
|
|
21
|
+
|
|
22
|
+
## 4. Document as You Go
|
|
23
|
+
|
|
24
|
+
- Update docs when behavior or scope changes.
|
|
25
|
+
- Keep specs and operational docs aligned with the code.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
version: 1.0.0
|
|
2
|
+
last_updated: 2026-03-13
|
|
3
|
+
next_review: 2026-03-20
|
|
4
|
+
|
|
5
|
+
planning:
|
|
6
|
+
auto_trigger_if:
|
|
7
|
+
- files_to_change > 5
|
|
8
|
+
- includes_architecture_decision: true
|
|
9
|
+
- includes_db_migration: true
|
|
10
|
+
- estimated_complexity > 7/10
|
|
11
|
+
- first_time_doing_this_task: true
|
|
12
|
+
skip_if:
|
|
13
|
+
- files_to_change <= 2
|
|
14
|
+
- similar_task_done_before: true
|
|
15
|
+
|
|
16
|
+
review:
|
|
17
|
+
auto_check:
|
|
18
|
+
tests_pass: true
|
|
19
|
+
lint_pass: true
|
|
20
|
+
type_check_pass: true
|
|
21
|
+
no_console_log: true
|
|
22
|
+
no_debugger: true
|
|
23
|
+
review_criteria:
|
|
24
|
+
- "Are there tests for functional changes?"
|
|
25
|
+
- "Is the code readable without extra explanation?"
|
|
26
|
+
- "Does the implementation follow existing patterns?"
|
|
27
|
+
- "Are there hidden side effects?"
|
|
28
|
+
|
|
29
|
+
testing:
|
|
30
|
+
evidence:
|
|
31
|
+
screenshots: "test-results/screenshots/"
|
|
32
|
+
logs: "test-results/logs/"
|
|
33
|
+
reports: "test-results/SLICE-XX-EVIDENCE-REPORT.md"
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Quiver Plantilla de Documentación
|
|
2
|
+
|
|
3
|
+
Quiver es una plantilla de documentación primero para proyectos que usan specs, slices y ejecución asistida por IA.
|
|
4
|
+
|
|
5
|
+
## Inicio Rápido
|
|
6
|
+
|
|
7
|
+
1. Copiá esta carpeta como `docs-template/` dentro del proyecto destino.
|
|
8
|
+
2. Ejecutá:
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
./docs-template/scripts/init-docs.sh "Nombre del Proyecto"
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
3. Editá los docs generados en `docs/` y el spec del proyecto en `specs/[project-name]/`.
|
|
15
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Guía de Personalización
|
|
2
|
+
|
|
3
|
+
Usá esta guía para adaptar la plantilla a un proyecto concreto.
|
|
4
|
+
|
|
5
|
+
## Setup
|
|
6
|
+
|
|
7
|
+
1. Ejecutá:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
./scripts/init-docs.sh "Nombre del Proyecto"
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
2. Editá:
|
|
14
|
+
|
|
15
|
+
- `docs/CONTEXTO.md`
|
|
16
|
+
- `docs/STATUS.md` si hace falta
|
|
17
|
+
- `specs/[project-name]/SPEC.md`
|
|
18
|
+
|
package/package.json
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "create-quiver",
|
|
3
|
+
"version": "0.4.0",
|
|
4
|
+
"private": false,
|
|
5
|
+
"description": "Quiver CLI for scaffolding projects from the packaged template",
|
|
6
|
+
"license": "MIT",
|
|
7
|
+
"bin": {
|
|
8
|
+
"create-quiver": "./bin/create-quiver.js"
|
|
9
|
+
},
|
|
10
|
+
"scripts": {
|
|
11
|
+
"check:slice": "bash tools/scripts/check-slice-readiness.sh",
|
|
12
|
+
"check:pr": "bash tools/scripts/check-pr-readiness.sh",
|
|
13
|
+
"start:slice": "bash tools/scripts/start-slice.sh",
|
|
14
|
+
"cleanup:slice": "bash tools/scripts/cleanup-slice.sh",
|
|
15
|
+
"package:quiver": "bash scripts/package-quiver.sh",
|
|
16
|
+
"smoke:create-quiver": "bash scripts/ci/smoke-create-quiver.sh",
|
|
17
|
+
"release:quiver": "bash scripts/release-quiver.sh"
|
|
18
|
+
}
|
|
19
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "quiver-docs-template",
|
|
3
|
+
"private": true,
|
|
4
|
+
"scripts": {
|
|
5
|
+
"check:slice": "bash tools/scripts/check-slice-readiness.sh",
|
|
6
|
+
"check:pr": "bash tools/scripts/check-pr-readiness.sh",
|
|
7
|
+
"start:slice": "bash tools/scripts/start-slice.sh",
|
|
8
|
+
"cleanup:slice": "bash tools/scripts/cleanup-slice.sh"
|
|
9
|
+
}
|
|
10
|
+
}
|