dave/storkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 7 Wiki Activity

Update Story Kit workflow docs and move story 26

Browse Source
This commit is contained in:
Dave
2026-02-17 14:12:45 +00:00
parent 5854ff5593
commit d0a1da2176
4 changed files with 34 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.story_kit/README.md
View File

@@ -13,7 +13,7 @@ Instead of ephemeral chat prompts ("Fix this", "Add that"), we work through pers
* **Tests** define the *Truth*.
* **Code** defines the *Reality*.
**The Golden Rule:** You are not allowed to write code until the Acceptance Criteria are captured in a test TODO file and the test plan is approved.
**The Golden Rule:** You are not allowed to write code until the Acceptance Criteria are captured in the story and the test plan is approved.
---
@@ -47,7 +47,7 @@ When the user asks for a feature, follow this 4-step loop strictly:
* **User Input:** "I want the robot to dance."
* **Action:** Create a file in `stories/upcoming/` (e.g., `stories/upcoming/XX_robot_dance.md`).
* **Move to Current:** Once the story is validated and ready for coding, move it to `stories/current/`.
* **Create Test TODOs:** Create `tests/todo/story-XX.todo` with one comment per Acceptance Criterion (e.g., `// AC: story-XX#1 - ...`).
* **Tracking:** Mark Acceptance Criteria as tested directly in the story file as tests are completed.
* **Content:**
* **User Story:** "As a user, I want..."
* **Acceptance Criteria:** Bullet points of observable success.
@@ -61,7 +61,7 @@ When the user asks for a feature, follow this 4-step loop strictly:
* Identify required unit tests and integration tests.
* Confirm test frameworks and commands from `specs/tech/STACK.md`.
* Ensure Acceptance Criteria are testable and mapped to planned tests.
* Each Acceptance Criterion must appear as a single TODO comment in `tests/todo/story-XX.todo`.
* Each Acceptance Criterion must be traceable to a specific test.
* **Output:** Show the user the test plan. **Wait for approval.**
### Step 3: The Implementation (Code)
@@ -69,7 +69,7 @@ When the user asks for a feature, follow this 4-step loop strictly:
* **Constraint:** adhere strictly to `specs/tech/STACK.md` (e.g., if it says "No `unwrap()`", you must not use `unwrap()`).
### Step 4: Verification (Close)
* **Action:** For each TODO comment, write a failing test (red), delete the comment, make the test pass (green), and refactor if needed. Keep only one failing test at a time.
* **Action:** For each Acceptance Criterion in the story, write a failing test (red), mark the criterion as tested, make the test pass (green), and refactor if needed. Keep only one failing test at a time.
* **Action:** Run compilation and make sure it succeeds without errors. Consult `specs/tech/STACK.md` and run all required linters listed there (treat warnings as errors). Run tests and make sure they all pass before proceeding. Ask questions here if needed.
* **Action:** Do not accept stories yourself. Ask the user if they accept the story. If they agree, move the story file to `stories/archived/`. Tell the user they should commit (this gives them the chance to exclude files via .gitignore if necessary).
* **Move to Archived:** After acceptance, move the story from `stories/current/` to `stories/archived/`.