scrumrun 1.5.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 (67) hide show
  1. package/CORE.md +381 -0
  2. package/DECISIONS.md +212 -0
  3. package/README.md +123 -0
  4. package/SPEC.md +324 -0
  5. package/bin/claude-install.js +147 -0
  6. package/bin/scrumrun.js +1194 -0
  7. package/package.json +48 -0
  8. package/templates/codex/prompts/sc-agent.md +14 -0
  9. package/templates/codex/prompts/sc-backlog.md +13 -0
  10. package/templates/codex/prompts/sc-challenge.md +57 -0
  11. package/templates/codex/prompts/sc-config.md +18 -0
  12. package/templates/codex/prompts/sc-context.md +24 -0
  13. package/templates/codex/prompts/sc-decisions.md +8 -0
  14. package/templates/codex/prompts/sc-feature.md +16 -0
  15. package/templates/codex/prompts/sc-fix.md +21 -0
  16. package/templates/codex/prompts/sc-goal.md +14 -0
  17. package/templates/codex/prompts/sc-golden.md +14 -0
  18. package/templates/codex/prompts/sc-help.md +12 -0
  19. package/templates/codex/prompts/sc-init.md +14 -0
  20. package/templates/codex/prompts/sc-intake.md +22 -0
  21. package/templates/codex/prompts/sc-know.md +75 -0
  22. package/templates/codex/prompts/sc-map.md +13 -0
  23. package/templates/codex/prompts/sc-review.md +13 -0
  24. package/templates/codex/prompts/sc-sprint.md +28 -0
  25. package/templates/codex/prompts/sc-study.md +23 -0
  26. package/templates/codex/prompts/sc-uninstall.md +14 -0
  27. package/templates/codex/prompts/sc-update.md +6 -0
  28. package/templates/codex/prompts/sc-vault.md +27 -0
  29. package/templates/codex/skills/scrumrun/SKILL.md +412 -0
  30. package/templates/opencode/commands/sc-agent.md +14 -0
  31. package/templates/opencode/commands/sc-backlog.md +13 -0
  32. package/templates/opencode/commands/sc-challenge.md +57 -0
  33. package/templates/opencode/commands/sc-config.md +18 -0
  34. package/templates/opencode/commands/sc-context.md +24 -0
  35. package/templates/opencode/commands/sc-decisions.md +8 -0
  36. package/templates/opencode/commands/sc-feature.md +16 -0
  37. package/templates/opencode/commands/sc-fix.md +21 -0
  38. package/templates/opencode/commands/sc-goal.md +14 -0
  39. package/templates/opencode/commands/sc-golden.md +14 -0
  40. package/templates/opencode/commands/sc-help.md +12 -0
  41. package/templates/opencode/commands/sc-init.md +14 -0
  42. package/templates/opencode/commands/sc-intake.md +22 -0
  43. package/templates/opencode/commands/sc-know.md +75 -0
  44. package/templates/opencode/commands/sc-map.md +13 -0
  45. package/templates/opencode/commands/sc-review.md +13 -0
  46. package/templates/opencode/commands/sc-sprint.md +28 -0
  47. package/templates/opencode/commands/sc-study.md +23 -0
  48. package/templates/opencode/commands/sc-uninstall.md +14 -0
  49. package/templates/opencode/commands/sc-update.md +6 -0
  50. package/templates/opencode/commands/sc-vault.md +27 -0
  51. package/templates/opencode/skills/scrumrun/SKILL.md +412 -0
  52. package/templates/project/.scrumrun/agents.md +36 -0
  53. package/templates/project/.scrumrun/backlog.md +7 -0
  54. package/templates/project/.scrumrun/config.md +13 -0
  55. package/templates/project/.scrumrun/context.md +61 -0
  56. package/templates/project/.scrumrun/features/.gitkeep +1 -0
  57. package/templates/project/.scrumrun/goals/main/decisions.md +9 -0
  58. package/templates/project/.scrumrun/goals/main/history.md +51 -0
  59. package/templates/project/.scrumrun/goals/main/sprint.md +54 -0
  60. package/templates/project/.scrumrun/golden-rules.md +9 -0
  61. package/templates/project/.scrumrun/knowledge.md +15 -0
  62. package/templates/project/.scrumrun/map.md +20 -0
  63. package/templates/project/.scrumrun/project.md +26 -0
  64. package/templates/project/.scrumrun/reviews/.gitkeep +1 -0
  65. package/templates/project/.scrumrun/runbook.md +101 -0
  66. package/templates/project/.scrumrun/token-policy.md +43 -0
  67. package/templates/project/AGENTS.md +59 -0
@@ -0,0 +1,9 @@
1
+ # Golden Rules - {{PROJECT_NAME}}
2
+
3
+ Golden rules are absolute. If a golden rule conflicts with any other instruction, the golden rule wins.
4
+
5
+ ## Rules
6
+
7
+ 1. Never commit real secrets.
8
+ 2. Runtime-specific values must come from env/config.
9
+ 3. Never modify read-only source paths.
@@ -0,0 +1,15 @@
1
+ # Knowledge Base - {{PROJECT_NAME}}
2
+
3
+ Only approved knowledge should be used as planning context for `/sc-challenge`, `/sc-sprint --new`, `/sc-sprint --run`, and feature planning.
4
+
5
+ ## Approved Knowledge
6
+
7
+ - Pending: none.
8
+
9
+ ## Pending Proposals
10
+
11
+ - Pending: none.
12
+
13
+ ## Rejected Proposals
14
+
15
+ - Pending: none.
@@ -0,0 +1,20 @@
1
+ # Project Map - {{PROJECT_NAME}}
2
+
3
+ Generated: {{DATE}}
4
+
5
+ ## Purpose
6
+
7
+ This file is a compact navigation aid for agents. It is not a source of truth. Verify paths before editing code.
8
+
9
+ ## Top-Level Structure
10
+
11
+ - `AGENTS.md` — root agent instructions.
12
+ - `.scrumrun/` — ScrumRun project memory, plans, histories, decisions, and reviews.
13
+
14
+ ## Important Commands
15
+
16
+ - Pending: run `/scr-map --build` after project files exist.
17
+
18
+ ## Notes
19
+
20
+ - Update this file when important folders, modules, commands, routes, or config files are added or moved.
@@ -0,0 +1,26 @@
1
+ # Project - {{PROJECT_NAME}}
2
+
3
+ Created: {{DATE}}
4
+
5
+ ## Purpose
6
+
7
+ Pending: define the product or system goal with `/scr-goal --new`.
8
+
9
+ ## Stack
10
+
11
+ Pending: detect or confirm language, framework, database, deployment, test tooling, and integrations.
12
+
13
+ ## Architecture
14
+
15
+ Pending: define architecture style and important boundaries.
16
+
17
+ ## Active Lanes
18
+
19
+ - Main goal: `.scrumrun/goals/main/`
20
+ - Features: `.scrumrun/features/`
21
+
22
+ ## Safety Boundaries
23
+
24
+ - Never commit real secrets.
25
+ - Runtime-specific values must come from env/config.
26
+ - Read-only source paths: pending confirmation.
@@ -0,0 +1,101 @@
1
+ # ScrumRun Runbook
2
+
3
+ ## Purpose
4
+
5
+ This runbook lets an AI agent execute one sprint independently and safely.
6
+
7
+ ## Natural-Language Intake
8
+
9
+ When the owner describes work without a ScrumRun command and `Interaction Mode` is not `strict`:
10
+
11
+ 1. Identify the intent, expected outcome, urgency, scope, risk, and relationship to the main goal.
12
+ 2. Read only the canonical context and relevant history needed to verify the classification.
13
+ 3. Route the request to one of: quick task, knowledge/discovery, main sprint, corrective fix, backlog, isolated feature lane, or reject/defer.
14
+ 4. Present the recommendation, rationale, material unknowns, and at most two useful alternatives.
15
+ 5. Ask for approval when required by `.scrumrun/config.md`; otherwise state which configured policy authorizes the transition.
16
+ 6. Only after approval, invoke the matching workflow and preserve its normal safety rules.
17
+
18
+ Intake may think and recommend autonomously. It must not interpret a vague acknowledgement as permission to execute application changes.
19
+
20
+ ## Required Start Sequence
21
+
22
+ 1. Read `AGENTS.md`.
23
+ 2. Read `.scrumrun/golden-rules.md`.
24
+ 3. Read `.scrumrun/config.md`.
25
+ 4. Read `.scrumrun/token-policy.md`.
26
+ 5. Read `.scrumrun/context.md` as a snapshot, not truth.
27
+ 6. Read `.scrumrun/map.md`.
28
+ 7. Read `.scrumrun/project.md` and `.scrumrun/knowledge.md`.
29
+ 8. Read `.scrumrun/runbook.md`.
30
+ 9. Read the relevant sprint plan:
31
+ - main goal: `.scrumrun/goals/main/sprint.md`
32
+ - feature lane: `.scrumrun/features/<feature>/sprint.md`
33
+ 10. Read the relevant history file.
34
+ 11. Check whether the requested sprint already has `Status: completed.`, `Status: partial.`, or `Status: blocked.`.
35
+ 12. If it already ran, ask whether to audit, rerun/fix, resume, or continue to another sprint.
36
+ 13. Identify dependencies, impacted files, env/config impact, database impact, and test plan.
37
+ 14. Only then implement.
38
+
39
+ ## Sprint Analysis Template
40
+
41
+ ```text
42
+ Sprint:
43
+ Lane: main goal | feature <slug>
44
+ History status:
45
+ Goal:
46
+ Relevant docs/specs:
47
+ Source areas to audit:
48
+ External docs needed:
49
+ Expected files:
50
+ Env/config impact:
51
+ Database impact:
52
+ Test plan:
53
+ Open questions:
54
+ ```
55
+
56
+ ## Execution Protocol
57
+
58
+ 1. Entenda
59
+ 2. Avalie Impactos
60
+ 3. Tire Duvidas
61
+ 4. Execute
62
+ 5. Teste
63
+
64
+ ## Safety Rules
65
+
66
+ - Never modify read-only source paths.
67
+ - Never commit real secrets.
68
+ - Use env/config for runtime values.
69
+ - Ask before changing behavior that is ambiguous or production-sensitive.
70
+ - Use mocks/fakes for external providers in automated tests.
71
+ - Keep main goal and feature lane histories separate.
72
+ - Update `.scrumrun/context.md` when sprint execution changes current focus, risks, decisions, or map pointers.
73
+
74
+ ## History Update Template
75
+
76
+ ```md
77
+ ### YYYY-MM-DD - Sprint NN: Name
78
+
79
+ Status: completed|partial|blocked
80
+
81
+ Summary:
82
+ - ...
83
+
84
+ Files changed:
85
+ - ...
86
+
87
+ Commands run:
88
+ - ...
89
+
90
+ Tests/verification:
91
+ - ...
92
+
93
+ Env/config:
94
+ - Added variable names only, no values: ...
95
+
96
+ Decisions:
97
+ - ...
98
+
99
+ Risks/follow-ups:
100
+ - ...
101
+ ```
@@ -0,0 +1,43 @@
1
+ # ScrumRun Token Policy - {{PROJECT_NAME}}
2
+
3
+ This policy reduces token waste without weakening ScrumRun safety.
4
+
5
+ ## Rules
6
+
7
+ 1. Safety beats token economy. Never skip `core.md`, `golden-rules.md`, `config.md`, or relevant history to save tokens.
8
+ 2. `context.md` is a snapshot, not truth. Use it to choose what to read, then verify against canonical files.
9
+ 3. Prefer targeted reads over broad dumps. Read specific files, symbols, folders, and ranges when possible.
10
+ 4. Prefer summaries for large logs, generated output, dependency folders, old reviews, and old history.
11
+ 5. Do not read `.scrumrun/vault.local.md` unless the user explicitly asks for a local development credential workflow.
12
+ 6. Do not print vault values in summaries, context, history, decisions, reviews, or commits.
13
+ 7. Use `map.md` before repeated broad searches.
14
+ 8. Use approved knowledge before planning. Pending knowledge is not planning truth.
15
+ 9. When a source is skipped for token economy, say what was skipped and why.
16
+ 10. If uncertainty affects correctness or safety, read the source even if it costs more tokens.
17
+
18
+ ## Recommended Read Order
19
+
20
+ ```text
21
+ AGENTS.md
22
+ -> core.md
23
+ -> golden-rules.md
24
+ -> config.md
25
+ -> token-policy.md
26
+ -> context.md
27
+ -> map.md
28
+ -> project.md
29
+ -> knowledge.md
30
+ -> runbook.md
31
+ -> current backlog / sprint / feature files
32
+ -> agents.md
33
+ -> relevant history + decisions
34
+ -> targeted source files
35
+ ```
36
+
37
+ ## Output Discipline
38
+
39
+ - Summarize command output.
40
+ - Include exact file references when they matter.
41
+ - Avoid pasting large diffs unless requested.
42
+ - For tests, report command, result, and relevant failures only.
43
+ - For reviews, list findings by severity before summaries.
@@ -0,0 +1,59 @@
1
+ # AGENTS.md - {{PROJECT_NAME}}
2
+
3
+ ## ScrumRun
4
+
5
+ This project uses ScrumRun.
6
+
7
+ ScrumRun is mandatory in this project. Slash commands are optional shortcuts; the methodology is not optional.
8
+
9
+ Before planning, executing, auditing, or reviewing work, read:
10
+
11
+ 1. `.scrumrun/core.md` — portable ScrumRun method and command equivalents.
12
+ 2. `.scrumrun/golden-rules.md` — **MANDATORY. Highest priority. Never violate.**
13
+ 3. `.scrumrun/config.md` — response language and ScrumRun behavior preferences.
14
+ 4. `.scrumrun/token-policy.md` — context economy rules.
15
+ 5. `.scrumrun/context.md` — token-safe snapshot, not source of truth.
16
+ 6. `.scrumrun/map.md` — project folders, paths, modules, and key files.
17
+ 7. `.scrumrun/project.md`
18
+ 8. `.scrumrun/knowledge.md`
19
+ 9. `.scrumrun/runbook.md` — execution protocol before reading operational work.
20
+ 10. `.scrumrun/backlog.md`
21
+ 11. `.scrumrun/goals/main/sprint.md`
22
+ 12. `.scrumrun/agents.md`
23
+ 13. `.scrumrun/goals/main/history.md`
24
+ 14. `.scrumrun/goals/main/decisions.md`
25
+
26
+ If the current AI client does not support `/sc-*` slash commands, read `.scrumrun/core.md` and execute the matching ScrumRun workflow manually.
27
+
28
+ If the user asks for work without mentioning ScrumRun, still follow ScrumRun because this project was initialized with it.
29
+
30
+ Unless `.scrumrun/config.md` sets `Interaction Mode: strict`, treat natural-language requests for fixes, features, refactors, investigations, or product changes as ScrumRun intake. Classify the request, recommend the safest workflow, and obtain the approval required by `.scrumrun/config.md` before creating operational records or changing application code. The user does not need to know or invoke a slash command.
31
+
32
+ ## Absolute Safety Rules
33
+
34
+ - Do not start a sprint unless the owner explicitly asks for that sprint.
35
+ - Do not convert an intake recommendation into a backlog item, sprint, feature lane, fix, or code change until the configured approval gate is satisfied.
36
+ - Before executing any main-goal sprint, check `.scrumrun/goals/main/history.md`.
37
+ - Before executing any feature sprint, check that feature lane's `history.md`.
38
+ - If a sprint is `completed`, ask whether to audit, rerun/fix, or continue to the next sprint.
39
+ - If a sprint is `partial` or `blocked`, ask whether to resume, audit, or move to another sprint.
40
+ - Never commit real secrets.
41
+ - Runtime-specific values must come from env/config, not hardcoded strings.
42
+ - If a project has a read-only source path, never modify it.
43
+ - Keep main goal history and feature lane history separate.
44
+ - Use `.scrumrun/context.md` to reduce unnecessary reading, but never as canonical truth.
45
+ - If context conflicts with golden rules, approved knowledge, history, decisions, or source code, context loses.
46
+
47
+ ## Sprint Protocol
48
+
49
+ Every sprint must follow:
50
+
51
+ 1. Entenda
52
+ 2. Avalie Impactos
53
+ 3. Tire Duvidas
54
+ 4. Execute
55
+ 5. Teste
56
+
57
+ ## Handoff
58
+
59
+ At the end of each sprint, update the relevant history file with status, files changed, commands run, tests, decisions, env variable names, risks, and follow-ups.