@arjunkhera/atlas 0.3.7 → 0.3.9

package/skills/sdlc-task/design/parts/actors.md

@@ -0,0 +1,26 @@
+# Who and what
+
+It holds: The people, agents and systems in the flow.
+
+Needs: Decide: optional, Flow: needed, Contract: optional, Initiative: none.
+
+Rules:
+
+1. Name each person, agent and system in the flow.
+2. Say what each one may do, and what it may not do.
+3. Use the same names in the stories.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: actors
+---
+# Who and what
+
+| Who | Does |
+|---|---|
+| Owner | Merges. |
+| Lead | Opens the pull request. Never merges. |
+| Gate | Runs the tests. |
+````

package/skills/sdlc-task/design/parts/alternatives.md

@@ -0,0 +1,24 @@
+# Alternatives
+
+It holds: The other options, and why each one lost.
+
+Needs: Decide: needed, Flow: optional, Contract: optional, Initiative: none.
+
+Rules:
+
+1. List each option we did not pick, and why it lost.
+2. Keep the reason to one or two sentences.
+3. Say what we keep from it, if anything.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: alternatives
+---
+# Alternatives
+
+| Option | Why it lost |
+|---|---|
+| Run after the merge | A red test reaches master. |
+````

package/skills/sdlc-task/design/parts/build.md

@@ -0,0 +1,23 @@
+# Build list
+
+It holds: The pieces to build, in order.
+
+Needs: Decide: needed, Flow: optional, Contract: optional, Initiative: none.
+
+Rules:
+
+1. List the pieces to build, in order.
+2. Each piece is small enough for one pull request.
+3. Say what each piece waits on.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: build
+---
+# Build list
+
+1. The gate workflow. Waits on nothing.
+2. The merge rule. Waits on 1.
+````

package/skills/sdlc-task/design/parts/calls.md

@@ -0,0 +1,25 @@
+# Calls and answers
+
+It holds: A real call and its real answer for each entry of the interface. A schema repo shows a real query; a plugin shows a tool call.
+
+Needs: Decide: none, Flow: none, Contract: needed, Initiative: none.
+
+Rules:
+
+1. Show one real call and its real answer for each route.
+2. Show one call that is refused, and its answer.
+3. Say where the example values come from.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: calls
+---
+# Calls and answers
+
+```text
+GET /documents/42/view
+200 OK  content-type: text/html
+```
+````

package/skills/sdlc-task/design/parts/change.md

@@ -0,0 +1,27 @@
+# Change and undo
+
+It holds: The kind of change, its impact, how to undo it, and each existing test it changes.
+
+Needs: Decide: needed, Flow: needed, Contract: needed, Initiative: optional.
+
+Rules:
+
+1. Name the kind of change: code, schema, config, docs or a rule.
+2. Say what it touches, how to undo it, and mark in bold a change that cannot be undone.
+3. List each existing test the change edits or removes, and why.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: change
+---
+# Change and undo
+
+| | What |
+|---|---|
+| Kind | Code: the gate workflow. |
+| Impact | Every pull request waits for the tests. |
+| Undo | Revert the pull request. |
+| Tests it changes | None. |
+````

package/skills/sdlc-task/design/parts/data.md

@@ -0,0 +1,22 @@
+# Data change
+
+It holds: The schema or data change. Write "No change" and why, when there is none, as a library or a CLI often does.
+
+Needs: Decide: none, Flow: none, Contract: needed, Initiative: none.
+
+Rules:
+
+1. Show the schema or data change as a diff.
+2. Write "No change" and the reason when there is none.
+3. Name each table or file that changes.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: data
+---
+# Data change
+
+No change. The viewer reads the existing documents table.
+````

package/skills/sdlc-task/design/parts/done.md

@@ -0,0 +1,23 @@
+# Done line
+
+It holds: Lines someone else can check. The approval lives in the tracker.
+
+Needs: Decide: needed, Flow: needed, Contract: needed, Initiative: needed.
+
+Rules:
+
+1. Write each line as a check someone else can run: the input, what happens and the output that passes.
+2. Each line names who runs it and the proof it leaves: a test, a command output or a page.
+3. The approval lives in the tracker, not here.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: done
+---
+# Done line
+
+1. A pull request with a red test cannot merge. The verifier plants a red test; the merge button stays blocked. Proof: the check run link.
+2. `npm test` passes. The verifier runs it. Proof: the test summary.
+````

package/skills/sdlc-task/design/parts/edges.md

@@ -0,0 +1,24 @@
+# Edge cases
+
+It holds: What happens when a step fails or comes in a strange order.
+
+Needs: Decide: optional, Flow: needed, Contract: optional, Initiative: none.
+
+Rules:
+
+1. List what happens when a step fails or comes in a strange order.
+2. Say what the user sees in each case.
+3. Cover a missing input, a retry and a timeout.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: edges
+---
+# Edge cases
+
+| Case | What happens |
+|---|---|
+| The gate times out | The merge stays blocked. The check says it timed out. |
+````

package/skills/sdlc-task/design/parts/goals.md

@@ -0,0 +1,27 @@
+# Goals and non-goals
+
+It holds: What it is for, what it is not, and how we know it worked.
+
+Needs: Decide: needed, Flow: needed, Contract: needed, Initiative: needed.
+
+Rules:
+
+1. List each goal and each non-goal in one table.
+2. A non-goal names something a reader may expect, and says it is out.
+3. End with one line: how we know it worked.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: goals
+---
+# Goals and non-goals
+
+| | What |
+|---|---|
+| Goal | A red test stops the merge. |
+| Non-goal | Running the tests on every push. |
+
+How we know it worked: no merge in a month has a red test after it.
+````

package/skills/sdlc-task/design/parts/key.md

@@ -0,0 +1,25 @@
+# Key
+
+It holds: Every word and code the design uses.
+
+Needs: Decide: needed, Flow: needed, Contract: needed, Initiative: needed.
+
+Rules:
+
+1. List every word and code the design uses that a new reader may not know.
+2. One row for each, with its meaning.
+3. The check flags a code with no row here.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: key
+---
+# Key
+
+| Word | Meaning |
+|---|---|
+| Gate | The check that runs before a merge. |
+| US-1 | The story "a test goes red". |
+````

package/skills/sdlc-task/design/parts/migration.md

@@ -0,0 +1,22 @@
+# Migration and undo
+
+It holds: How old data moves to the new shape, and how the data change is undone.
+
+Needs: Decide: none, Flow: none, Contract: needed, Initiative: none.
+
+Rules:
+
+1. Say how old data moves to the new shape.
+2. Say how to undo the change, step by step.
+3. Mark in bold a change that cannot be undone.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: migration
+---
+# Migration and undo
+
+Undo: revert the pull request. No data moves.
+````

package/skills/sdlc-task/design/parts/order.md

@@ -0,0 +1,24 @@
+# Order and dependencies
+
+It holds: Which design comes first, and what each one waits on.
+
+Needs: Decide: none, Flow: none, Contract: none, Initiative: needed.
+
+Rules:
+
+1. Say which design comes first.
+2. Say what each design waits on.
+3. Draw the order when there are more than three designs.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: order
+---
+# Order and dependencies
+
+1. The shared queue.
+2. The PDF reader, after 1.
+3. The image reader, after 1.
+````

package/skills/sdlc-task/design/parts/problem.md

@@ -0,0 +1,22 @@
+# Problem today
+
+It holds: What happens today, with a real example.
+
+Needs: Decide: needed, Flow: optional, Contract: optional, Initiative: none.
+
+Rules:
+
+1. Say what happens today, with one real example.
+2. Cite the source: a pull request, an issue or a log line.
+3. Do not propose a fix here.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: problem
+---
+# Problem today
+
+Today the tests run after the merge. On 2 October pull request 88 merged, and its tests went red one hour later.
+````

package/skills/sdlc-task/design/parts/proof.md

@@ -0,0 +1,24 @@
+# Test and proof plan
+
+It holds: How each piece proves itself.
+
+Needs: Decide: needed, Flow: needed, Contract: needed, Initiative: none.
+
+Rules:
+
+1. Say how each piece proves itself.
+2. Prefer a test that fails when the code is wrong.
+3. Name the command that runs it.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: proof
+---
+# Test and proof plan
+
+| Piece | Proof |
+|---|---|
+| The gate | A planted red test blocks the merge. |
+````

package/skills/sdlc-task/design/parts/proposal.md

@@ -0,0 +1,24 @@
+# Proposal
+
+It holds: The option we pick, and how it works.
+
+Needs: Decide: needed, Flow: none, Contract: none, Initiative: none.
+
+Rules:
+
+1. Name the option we pick, and say how it works in steps.
+2. Give a worked example: the input, the process and the output.
+3. Link the figure that shows it.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: proposal
+---
+# Proposal
+
+1. A pull request opens.
+2. The gate runs the tests on its head.
+3. A red test blocks the merge button.
+````

package/skills/sdlc-task/design/parts/records.md

@@ -0,0 +1,24 @@
+# Records
+
+It holds: The records each step reads and writes.
+
+Needs: Decide: none, Flow: needed, Contract: optional, Initiative: none.
+
+Rules:
+
+1. List each record a step reads or writes.
+2. Say which step writes it, and where it lives.
+3. Name the fields that matter.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: records
+---
+# Records
+
+| Record | Written by | Holds |
+|---|---|---|
+| Check run | The gate | The result and the log link |
+````

package/skills/sdlc-task/design/parts/repos.md

@@ -0,0 +1,25 @@
+# Each kind of repo
+
+It holds: What the design means for a service, a library, a schema, a CLI and a plugin.
+
+Needs: Decide: shared, Flow: shared, Contract: shared, Initiative: none.
+
+Rules:
+
+1. Say what the design means for a service, a library, a schema, a CLI and a plugin.
+2. Needed when many repos use the design. Optional for a design in one product.
+3. Say what stays the same for every kind.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: repos
+---
+# Each kind of repo
+
+| Kind | What changes |
+|---|---|
+| Service | The gate also waits for the deploy check. |
+| Library | The gate runs the unit tests only. |
+````

package/skills/sdlc-task/design/parts/risks.md

@@ -0,0 +1,24 @@
+# Risks
+
+It holds: What breaks, and what we do. "Accepted" with a reason is valid.
+
+Needs: Decide: needed, Flow: needed, Contract: needed, Initiative: needed.
+
+Rules:
+
+1. List what can break, and what we do about it.
+2. "Accepted" with a reason is a valid answer.
+3. Put the worst risk first.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: risks
+---
+# Risks
+
+| Risk | What we do |
+|---|---|
+| The gate is slow | Accepted: ten minutes is fine for now. |
+````

package/skills/sdlc-task/design/parts/rollout.md

@@ -0,0 +1,24 @@
+# Rollout
+
+It holds: The order of release, and how we watch it.
+
+Needs: Decide: optional, Flow: optional, Contract: needed, Initiative: none.
+
+Rules:
+
+1. Give the order of release.
+2. Say how we watch it after the release.
+3. Say what makes us roll back.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: rollout
+---
+# Rollout
+
+1. Release behind a flag.
+2. Turn it on for the owner.
+3. Watch the error rate for one day, then turn it on for all.
+````

package/skills/sdlc-task/design/parts/routes.md

@@ -0,0 +1,24 @@
+# Routes and interface
+
+It holds: Every route, exported function, command, tool or schema object that is added, changed or removed.
+
+Needs: Decide: none, Flow: none, Contract: needed, Initiative: none.
+
+Rules:
+
+1. List every route, function, command or tool that is added, changed or removed.
+2. Mark each row as new, changed or removed.
+3. For a library, list exported functions; for a CLI, commands and flags.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: routes
+---
+# Routes and interface
+
+| | Route | What it does |
+|---|---|---|
+| new | `GET /documents/:id/view` | Returns the viewer page for one document. |
+````

package/skills/sdlc-task/design/parts/scorecard.md

@@ -0,0 +1,25 @@
+# Scorecard
+
+It holds: Each option against each yardstick test.
+
+Needs: Decide: needed, Flow: none, Contract: none, Initiative: none.
+
+Rules:
+
+1. Score each option against each yardstick test.
+2. Use words, not only marks: yes, no or part.
+3. The picked option is the first row.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: scorecard
+---
+# Scorecard
+
+| Option | Stops red | Fast |
+|---|---|---|
+| Gate before merge | yes | yes |
+| Run after merge | no | yes |
+````

package/skills/sdlc-task/design/parts/security.md

@@ -0,0 +1,22 @@
+# Security
+
+It holds: Who may call it, what it may reach, and what it never leaks.
+
+Needs: Decide: optional, Flow: optional, Contract: needed, Initiative: none.
+
+Rules:
+
+1. Say who may call it, and what it may reach.
+2. Say what it never leaks, and how the tests prove it.
+3. Name the repo's own rules first.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: security
+---
+# Security
+
+Only the document's owner may open the view. A call from another tenant gets 404, and a test proves it.
+````

package/skills/sdlc-task/design/parts/shared-decisions.md

@@ -0,0 +1,24 @@
+# Shared decisions
+
+It holds: The decisions every design in the family follows, and why.
+
+Needs: Decide: none, Flow: none, Contract: none, Initiative: needed.
+
+Rules:
+
+1. List the decisions every design in the family follows.
+2. Give the reason for each one.
+3. Link the tracker decision when one exists.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: shared-decisions
+---
+# Shared decisions
+
+| Decision | Why |
+|---|---|
+| One queue for every reader | One place to watch and retry. |
+````

package/skills/sdlc-task/design/parts/states.md

@@ -0,0 +1,25 @@
+# States
+
+It holds: The states a thing moves through, and what moves it.
+
+Needs: Decide: none, Flow: optional, Contract: none, Initiative: none.
+
+Rules:
+
+1. List the states a thing moves through.
+2. Say what moves it from each state to the next.
+3. Draw it as a state figure.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: states
+---
+# States
+
+| From | Event | To |
+|---|---|---|
+| Waiting | The tests start | Running |
+| Running | A test fails | Red |
+````

package/skills/sdlc-task/design/parts/stories.md

@@ -0,0 +1,26 @@
+# Stories
+
+It holds: One walkthrough for each story, step by step.
+
+Needs: Decide: optional, Flow: needed, Contract: optional, Initiative: none.
+
+Rules:
+
+1. Write one walkthrough for each story, step by step.
+2. Each step has a title and one or two sentences.
+3. Give each story a code, such as `US-1`, and put the code in the Key.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: stories
+---
+# Stories
+
+### US-1: a test goes red
+
+1. The lead opens a pull request.
+2. The gate runs the tests, and one goes red.
+3. The merge button stays blocked, and the owner sees the failing check.
+````

package/skills/sdlc-task/design/parts/summary.md

@@ -0,0 +1,33 @@
+# Summary
+
+It holds: The answer in a few lines, and one picture.
+
+Needs: Decide: needed, Flow: needed, Contract: needed, Initiative: needed.
+
+Rules:
+
+1. Lead with the answer: what changes, for whom, and why now.
+2. Keep it to two short paragraphs and one picture.
+3. A reader who stops here knows the whole design.
+
+Example, in a file of its own:
+
+````markdown
+---
+part: summary
+---
+# Summary
+
+Atlas runs the tests of a pull request before the merge, not after it.
+A red test stops the merge and names the failing check.
+
+```figure
+<svg viewBox="0 0 420 60" role="img" aria-label="Pull request, then tests, then merge">
+  <g font-family="var(--mono)" font-size="13" fill="var(--ink)">
+    <rect x="2" y="14" width="120" height="32" rx="6" fill="var(--card)" stroke="var(--line-strong)"/><text x="20" y="35">Pull request</text>
+    <rect x="150" y="14" width="120" height="32" rx="6" fill="var(--accent-bg)" stroke="var(--accent)"/><text x="188" y="35">Tests</text>
+    <rect x="298" y="14" width="120" height="32" rx="6" fill="var(--card)" stroke="var(--line-strong)"/><text x="336" y="35">Merge</text>
+  </g>
+</svg>
+```
+````