Initial workflow template
- docs/workflow/: INDEX, ISSUE-FORMAT, WORKFLOW, AGENT-PROMPTS - .issues/: INDEX, example issue - .hooks/: issue-linter.js (pre-commit validator) - package.json with setup script - README.md See docs/workflow/INDEX.md to get started.
This commit is contained in:
35
.issues/INDEX.md
Normal file
35
.issues/INDEX.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# Issue Index
|
||||
|
||||
All open and closed issues for this project.
|
||||
|
||||
## Open Issues
|
||||
|
||||
| # | Title | Priority | Depends On | Status |
|
||||
|---|---|---|---|---|
|
||||
| — | No open issues | — | — | — |
|
||||
|
||||
## Closed Issues
|
||||
|
||||
| # | Title | Completed |
|
||||
|---|---|---|
|
||||
| — | No closed issues | — |
|
||||
|
||||
## Legend
|
||||
|
||||
- **Priority**: low < medium < high < critical
|
||||
- **Status**: open → in-progress → done (or blocked)
|
||||
- **Depends On**: Blocked until these issues are done
|
||||
|
||||
## Creating a New Issue
|
||||
|
||||
1. Pick the next number (highest + 1)
|
||||
2. Create `/.issues/<number>-<slug>.md`
|
||||
3. Use format from `/docs/workflow/ISSUE-FORMAT.md`
|
||||
4. Add entry to this table
|
||||
5. See `/docs/workflow/AGENT-PROMPTS.md` for creation prompt
|
||||
|
||||
## Workflow Overview
|
||||
|
||||
See `/docs/workflow/INDEX.md` for quick start.
|
||||
|
||||
See `/docs/workflow/WORKFLOW.md` for detailed stages.
|
||||
56
.issues/example/001-example-issue.md
Normal file
56
.issues/example/001-example-issue.md
Normal file
@@ -0,0 +1,56 @@
|
||||
---
|
||||
id: 001
|
||||
title: Example issue with full format
|
||||
status: open
|
||||
priority: medium
|
||||
created: 2024-04-18
|
||||
---
|
||||
|
||||
## What
|
||||
This is an example issue demonstrating the complete format. Replace this with your actual issue.
|
||||
|
||||
## Why
|
||||
Use this as a template when creating new issues. Delete this issue after reviewing the format.
|
||||
|
||||
## Acceptance Criteria
|
||||
- [ ] This example can be deleted
|
||||
- [ ] Format is clear and usable
|
||||
- [ ] All required sections are present
|
||||
|
||||
## Verification
|
||||
1. Read this file
|
||||
2. Verify all sections are present
|
||||
3. Delete this file when done
|
||||
|
||||
---
|
||||
|
||||
## Agent Working Notes
|
||||
|
||||
### Plan
|
||||
<!-- What approach will you take? List steps before coding. -->
|
||||
- [ ]
|
||||
|
||||
### Status Log
|
||||
<!-- Timestamped entries: what was done, what was decided, what was found -->
|
||||
|
||||
### Blockers
|
||||
<!-- List any blockers with proposed solutions. If none, write "None." -->
|
||||
|
||||
### Self-Verification
|
||||
<!-- Must be filled before claiming done -->
|
||||
- [ ] Smoke test ran:
|
||||
- [ ] Acceptance criteria checked:
|
||||
- [ ] Screenshot taken (if UI change):
|
||||
- [ ] Dependent issues still work:
|
||||
|
||||
### Human Review Notes
|
||||
<!-- Human fills after agent marks done -->
|
||||
|
||||
Review date:
|
||||
|
||||
Reasoning check:
|
||||
- [ ] Plan makes sense
|
||||
- [ ] Status log shows good decisions
|
||||
- [ ] Self-verification is complete and honest
|
||||
|
||||
Feedback:
|
||||
Reference in New Issue
Block a user