@@ -5,23 +5,27 @@ This repository uses GitHub Issues as the primary task management system.
55## When to Create Issues
66
77Create GitHub issues for:
8+
89- Bugs discovered during development
910- Feature requests and enhancements
1011- Tasks that cannot be completed in the current session
1112- Work items that need tracking across multiple sessions
1213- Items requiring user input or review before proceeding
1314
1415Do NOT create issues for:
16+
1517- Tasks you can complete immediately
1618- Temporary notes (use scratch files instead)
1719
1820## Issue Structure
1921
2022** Title** : Clear, actionable description starting with a verb
23+
2124- Good: "Add validation for plugin manifest files"
2225- Bad: "Validation issue" or "Plugin stuff"
2326
2427** Body** : Include context an AI agent needs to pick up the work:
28+
2529- What needs to be done
2630- Why it matters
2731- Acceptance criteria (if applicable)
@@ -31,45 +35,48 @@ Do NOT create issues for:
3135
3236Use labels to indicate issue state beyond open/closed:
3337
34- | Label | Purpose |
35- | -------| ---------|
36- | ` status:in-progress ` | Actively being worked on |
37- | ` status:blocked ` | Cannot proceed - see comments for blocker |
38- | ` status:needs-review ` | Work complete, awaiting human review |
39- | ` status:on-hold ` | Intentionally paused, not abandoned |
38+ | Label | Purpose |
39+ | --------------------- | ----------------------------------------- |
40+ | ` status:in-progress ` | Actively being worked on |
41+ | ` status:blocked ` | Cannot proceed - see comments for blocker |
42+ | ` status:needs-review ` | Work complete, awaiting human review |
43+ | ` status:on-hold ` | Intentionally paused, not abandoned |
4044
4145## Labels for Issue Type
4246
43- | Label | Purpose |
44- | -------| ---------|
45- | ` bug ` | Something isn't working correctly |
46- | ` enhancement ` | New feature or improvement |
47- | ` documentation ` | Documentation updates needed |
48- | ` chore ` | Maintenance, refactoring, cleanup |
47+ | Label | Purpose |
48+ | --------------- | --------------------------------- |
49+ | ` bug ` | Something isn't working correctly |
50+ | ` enhancement ` | New feature or improvement |
51+ | ` documentation ` | Documentation updates needed |
52+ | ` chore ` | Maintenance, refactoring, cleanup |
4953
5054## Labels for Priority
5155
52- | Label | Purpose |
53- | -------| ---------|
54- | ` priority:high ` | Address soon, blocks other work |
55- | ` priority:low ` | Nice to have, do when convenient |
56+ | Label | Purpose |
57+ | --------------- | -------------------------------- |
58+ | ` priority:high ` | Address soon, blocks other work |
59+ | ` priority:low ` | Nice to have, do when convenient |
5660
5761## Working with Issues
5862
5963** Starting work on an issue:**
64+
6065``` bash
6166# Add in-progress label
6267gh issue edit < number> --add-label " status:in-progress"
6368```
6469
6570** When blocked:**
71+
6672``` bash
6773# Add blocked label and comment explaining why
6874gh issue edit < number> --add-label " status:blocked"
6975gh issue comment < number> --body " Blocked: <reason>"
7076```
7177
7278** Completing work:**
79+
7380``` bash
7481# Remove status labels, close with comment
7582gh issue edit < number> --remove-label " status:in-progress"
0 commit comments