mirror of
https://github.com/turbot/steampipe.git
synced 2025-12-19 09:58:53 -05:00
AI Development Guide for Steampipe
This directory contains documentation, templates, and conventions for AI-assisted development on the Steampipe project.
Guides
- Bug Fix PRs - Two-commit pattern, branch naming, PR format for bug fixes
- GitHub Issues - Reporting bugs and issues
- Test Generation - Writing effective tests
- Parallel Coordination - Working with multiple agents in parallel
Directory Structure
.ai/
├── docs/ # Permanent documentation and guides
├── templates/ # Issue and PR templates
└── wip/ # Temporary workspace (gitignored)
Key Conventions
- Base branch:
developfor all work - Bug fixes: 2-commit pattern (demonstrate → fix)
- Small PRs: One logical change per PR
- Issue linking: PR title ends with
closes #XXXX
For AI Agents
- Reference the relevant guide in
docs/for your task - Use templates in
templates/for PR descriptions - Use
wip/<topic>/for coordinated parallel work (gitignored) - Follow project conventions for branches, commits, and PRs
Parallel work pattern: Create .ai/wip/<topic>/ with task files, then agents can work independently. See parallel-coordination.md.