mirror of
https://github.com/wailsapp/wails.git
synced 2026-03-18 00:19:58 +01:00
c62a094b9a
- Fix merge conflict marker in application_options.go - Add AGENTS.md with beads workflow documentation for AI agents 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
143 lines
4.3 KiB
Markdown
143 lines
4.3 KiB
Markdown
# AI Agent Instructions for Wails v3
|
|
|
|
## Issue Tracking with bd (beads)
|
|
|
|
**IMPORTANT**: This project uses **bd (beads)** for ALL issue tracking. Do NOT use markdown TODOs, task lists, or other tracking methods.
|
|
|
|
### Why bd?
|
|
|
|
- Dependency-aware: Track blockers and relationships between issues
|
|
- Git-friendly: Auto-syncs to JSONL for version control
|
|
- Agent-optimized: JSON output, ready work detection, discovered-from links
|
|
- Prevents duplicate tracking systems and confusion
|
|
|
|
### Quick Start
|
|
|
|
**Check for ready work:**
|
|
```bash
|
|
bd ready --json
|
|
```
|
|
|
|
**Create new issues:**
|
|
```bash
|
|
bd create "Issue title" -t bug|feature|task -p 0-4 --json
|
|
bd create "Issue title" -p 1 --deps discovered-from:bd-123 --json
|
|
bd create "Subtask" --parent <epic-id> --json # Hierarchical subtask (gets ID like epic-id.1)
|
|
```
|
|
|
|
**Claim and update:**
|
|
```bash
|
|
bd update bd-42 --status in_progress --json
|
|
bd update bd-42 --priority 1 --json
|
|
```
|
|
|
|
**Complete work:**
|
|
```bash
|
|
bd close bd-42 --reason "Completed" --json
|
|
```
|
|
|
|
### Issue Types
|
|
|
|
- `bug` - Something broken
|
|
- `feature` - New functionality
|
|
- `task` - Work item (tests, docs, refactoring)
|
|
- `epic` - Large feature with subtasks
|
|
- `chore` - Maintenance (dependencies, tooling)
|
|
|
|
### Priorities
|
|
|
|
- `0` - Critical (security, data loss, broken builds)
|
|
- `1` - High (major features, important bugs)
|
|
- `2` - Medium (default, nice-to-have)
|
|
- `3` - Low (polish, optimization)
|
|
- `4` - Backlog (future ideas)
|
|
|
|
### Workflow for AI Agents
|
|
|
|
1. **Check ready work**: `bd ready` shows unblocked issues
|
|
2. **Claim your task**: `bd update <id> --status in_progress`
|
|
3. **Work on it**: Implement, test, document
|
|
4. **Discover new work?** Create linked issue:
|
|
- `bd create "Found bug" -p 1 --deps discovered-from:<parent-id>`
|
|
5. **Complete**: `bd close <id> --reason "Done"`
|
|
6. **Commit together**: Always commit the `.beads/issues.jsonl` file together with the code changes so issue state stays in sync with code state
|
|
|
|
### Auto-Sync
|
|
|
|
bd automatically syncs with git:
|
|
- Exports to `.beads/issues.jsonl` after changes (5s debounce)
|
|
- Imports from JSONL when newer (e.g., after `git pull`)
|
|
- No manual export/import needed!
|
|
|
|
### GitHub Copilot Integration
|
|
|
|
If using GitHub Copilot, also create `.github/copilot-instructions.md` for automatic instruction loading.
|
|
Run `bd onboard` to get the content, or see step 2 of the onboard instructions.
|
|
|
|
### MCP Server (Recommended)
|
|
|
|
If using Claude or MCP-compatible clients, install the beads MCP server:
|
|
|
|
```bash
|
|
pip install beads-mcp
|
|
```
|
|
|
|
Add to MCP config (e.g., `~/.config/claude/config.json`):
|
|
```json
|
|
{
|
|
"beads": {
|
|
"command": "beads-mcp",
|
|
"args": []
|
|
}
|
|
}
|
|
```
|
|
|
|
Then use `mcp__beads__*` functions instead of CLI commands.
|
|
|
|
### Managing AI-Generated Planning Documents
|
|
|
|
AI assistants often create planning and design documents during development:
|
|
- PLAN.md, IMPLEMENTATION.md, ARCHITECTURE.md
|
|
- DESIGN.md, CODEBASE_SUMMARY.md, INTEGRATION_PLAN.md
|
|
- TESTING_GUIDE.md, TECHNICAL_DESIGN.md, and similar files
|
|
|
|
**Best Practice: Use a dedicated directory for these ephemeral files**
|
|
|
|
**Recommended approach:**
|
|
- Create a `history/` directory in the project root
|
|
- Store ALL AI-generated planning/design docs in `history/`
|
|
- Keep the repository root clean and focused on permanent project files
|
|
- Only access `history/` when explicitly asked to review past planning
|
|
|
|
**Example .gitignore entry (optional):**
|
|
```
|
|
# AI planning documents (ephemeral)
|
|
history/
|
|
```
|
|
|
|
**Benefits:**
|
|
- Clean repository root
|
|
- Clear separation between ephemeral and permanent documentation
|
|
- Easy to exclude from version control if desired
|
|
- Preserves planning history for archeological research
|
|
- Reduces noise when browsing the project
|
|
|
|
### CLI Help
|
|
|
|
Run `bd <command> --help` to see all available flags for any command.
|
|
For example: `bd create --help` shows `--parent`, `--deps`, `--assignee`, etc.
|
|
|
|
### Important Rules
|
|
|
|
- Use bd for ALL task tracking
|
|
- Always use `--json` flag for programmatic use
|
|
- Link discovered work with `discovered-from` dependencies
|
|
- Check `bd ready` before asking "what should I work on?"
|
|
- Store AI planning docs in `history/` directory
|
|
- Run `bd <cmd> --help` to discover available flags
|
|
- Do NOT create markdown TODO lists
|
|
- Do NOT use external issue trackers
|
|
- Do NOT duplicate tracking systems
|
|
- Do NOT clutter repo root with planning documents
|
|
|
|
For more details, see README.md and QUICKSTART.md.
|