Skip to content

Commit 3eb9d45

Browse files
committed
docs: update CLAUDE.md and TASKS.md for GitHub-driven workflow and task management improvements
1 parent 3b0459a commit 3eb9d45

3 files changed

Lines changed: 91 additions & 501 deletions

File tree

CLAUDE.md

Lines changed: 56 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -92,30 +92,70 @@ cd gearbox-agent && make deploy
9292

9393
See [docs/plugins.md](docs/plugins.md) for complete plugin architecture documentation.
9494

95-
## Task Management (TASKS.md)
95+
## GitHub-Driven Workflow
9696

97-
**CRITICAL**: This repository uses TASKS.md to track work items.
97+
**CRITICAL**: All features and bugs go through a full GitHub workflow. Claude manages this end-to-end.
9898

99-
### Adding Tasks
99+
### Workflow Steps
100100

101-
When creating tasks in TASKS.md:
101+
When a new feature is planned or a bug is reported:
102102

103-
- Add them under the `## Active Tasks` section
104-
- Use markdown checkbox syntax: `- [ ] Task description`
105-
- Tasks should be clear, actionable, and specific
103+
1. **Create a GitHub Issue** — Use `gh issue create` with a clear title, description, and appropriate labels (`enhancement`, `bug`, etc.)
104+
2. **Add to Project Board** — Add the issue to the GitHub Project board using `gh project item-add`
105+
3. **Create a Feature Branch** — Branch from `main` using the naming convention below
106+
4. **Do the Work** — Implement the feature or fix on the branch
107+
5. **Create a PR** — Use `gh pr create` targeting `main`, linked to the issue (use `Closes #N` in the body)
108+
6. **Track Progress** — Keep the project board and issues in sync
109+
7. **Complete** — When user confirms done: merge PR, close issue, move project card to Done
106110

107-
### Completing Tasks
111+
### Branch Naming Convention
108112

109-
- Check off tasks as you complete them: `- [x] Task description`
110-
- Mark tasks complete immediately when work is done
111-
- Don't batch completions - check them off right away
113+
- **Features:** `feature/short-description` (e.g., `feature/dashboard-export`)
114+
- **Bug fixes:** `fix/short-description` (e.g., `fix/websocket-reconnect`)
115+
- **Always branch from `main`**
112116

113-
### Workflow Skills
117+
### PR Convention
118+
119+
- All PRs target `main`
120+
- PR body must include `Closes #<issue-number>` to auto-close the issue on merge
121+
- Use the standard PR template format (Summary, Test Plan)
122+
123+
### Issue Labels
124+
125+
Use these labels consistently:
126+
127+
- `enhancement` — New features
128+
- `bug` — Bug fixes
129+
- `documentation` — Docs-only changes
130+
- `refactor` — Code improvements without behavior change
131+
132+
### Project Board
133+
134+
- **Project Number:** 3
135+
- **Project ID:** `PVT_kwHOADN1xs4BOB1W`
136+
- **Owner:** `sarg3nt`
114137

115-
Use these skills to work with TASKS.md:
138+
Use `gh project` commands and the MCP GitHub Projects tool to:
139+
140+
- Add new issues to the board
141+
- Move items between columns as work progresses
142+
- Query board status when reporting progress
143+
144+
## TASKS.md as Scratch Pad
145+
146+
TASKS.md is a **scratch pad only** — not a tracking system. The GitHub Project board is the source of truth for all work items.
147+
148+
### How TASKS.md is used
149+
150+
- User writes rough ideas, feature descriptions, or bug notes in TASKS.md
151+
- Claude reads TASKS.md, breaks the content into actionable GitHub issues, and adds them to the project board
152+
- Once issues are created, the content in TASKS.md can be cleared
153+
- TASKS.md is never the source of truth — the project board is
154+
155+
### Workflow Skills
116156

117-
- `/dowork` - Start the first unchecked task, ask questions as needed
118-
- `/doallwork` - Complete the first unchecked task autonomously without questions
157+
- `/dowork` - Read TASKS.md, create issues from it, and start working (ask questions as needed)
158+
- `/doallwork` - Read TASKS.md, create issues from it, and work autonomously
119159

120160
## User Preferences
121161

@@ -213,7 +253,7 @@ Store in `docs/` directory using kebab-case naming. Include TOC after main headi
213253
- **[README.md](README.md)**: Project overview and quick start - SOURCE OF TRUTH
214254
- **[CLAUDE.md](CLAUDE.md)**: This file (development guidance)
215255
- **[docs/plugins.md](docs/plugins.md)**: Complete plugin architecture documentation
216-
- **[TASKS.md](TASKS.md)**: Active development tasks
256+
- **[TASKS.md](TASKS.md)**: Scratch pad for describing upcoming work
217257
- **[gearbox/docs/development.md](gearbox/docs/development.md)**: Local development guide
218258

219259
**Application Documentation:**

0 commit comments

Comments
 (0)