Skip to content

Commit c1d3004

Browse files
jrosskopfclaude
andcommitted
docs: Add GitHub Issue Workflow section to AGENTS.md
Document the workflow for working on GitHub issues using feature branches and pull requests. Includes branch naming conventions, PR template, and integration with beads issue tracking. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 02bc802 commit c1d3004

1 file changed

Lines changed: 64 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1552,6 +1552,70 @@ Before completing work that modifies code:
15521552
- NEVER say "ready to push when you are" - YOU must push
15531553
- If push fails, resolve and retry until it succeeds
15541554

1555+
## GitHub Issue Workflow
1556+
1557+
When working on GitHub issues, use feature branches and pull requests to enable code review and maintain a clean main branch history.
1558+
1559+
**Workflow Steps:**
1560+
1561+
1. **Create feature branch from main:**
1562+
```bash
1563+
git checkout main
1564+
git pull origin main
1565+
git checkout -b feature/gh-<issue-number>-<short-description>
1566+
# Example: git checkout -b feature/gh-9-arrow-streaming
1567+
```
1568+
1569+
2. **Create or link beads epic (optional but recommended):**
1570+
```bash
1571+
bd create --title="<GitHub Issue Title>" --type=epic --priority=1
1572+
# Add external link to GitHub issue
1573+
bd update <beads-id> --notes="GitHub: https://github.com/DataZooDE/flapi/issues/<N>"
1574+
```
1575+
1576+
3. **Work and commit on feature branch:**
1577+
- Make changes, run tests
1578+
- Commit with descriptive messages
1579+
- Reference GitHub issue: `git commit -m "feat: Add Arrow streaming support (#9)"`
1580+
1581+
4. **Create pull request:**
1582+
```bash
1583+
git push -u origin feature/gh-<issue-number>-<short-description>
1584+
gh pr create --title "..." --body "Closes #<issue-number>..."
1585+
```
1586+
1587+
5. **After PR merge:**
1588+
```bash
1589+
git checkout main
1590+
git pull origin main
1591+
git branch -d feature/gh-<issue-number>-<short-description>
1592+
bd close <beads-epic-id>
1593+
bd sync
1594+
```
1595+
1596+
**Branch Naming Convention:**
1597+
- `feature/gh-<N>-<description>` - For GitHub issue work
1598+
- `fix/gh-<N>-<description>` - For bug fixes
1599+
- `chore/gh-<N>-<description>` - For maintenance tasks
1600+
1601+
**PR Description Template:**
1602+
```markdown
1603+
## Summary
1604+
<1-3 bullet points>
1605+
1606+
## Test plan
1607+
- [ ] Tests added/updated
1608+
- [ ] Manual verification steps
1609+
1610+
Closes #<issue-number>
1611+
```
1612+
1613+
**Integration with Beads:**
1614+
- Beads tracks local work breakdown and dependencies
1615+
- GitHub issues track public feature requests and bugs
1616+
- Link them via notes field: `bd update <id> --notes="GitHub: #N"`
1617+
- Close beads epic after PR merges
1618+
15551619
## Beads Issue Tracking
15561620

15571621
Beads (`bd`) is a git-backed issue tracker used in this project. This section documents operational lessons learned, particularly for multi-repo configurations.

0 commit comments

Comments
 (0)