- [x] Create agents.md file in root directory - [x] Focus on development workflow as requested - [x] Reference existing documentation (README.md, CONTRIBUTING.md, pyproject.toml) - [x] Include setup instructions and make targets - [x] Document testing patterns and structure - [x] Include code quality standards (ruff, mypy, pyright) - [x] Add commit message conventions with scopes - [x] Include project structure overview - [x] Document CI/CD workflows - [x] Add tips for agents working with the codebase - [x] Document breaking change patterns to avoid - [x] Verify formatting with prettier ✓ - [x] Verify spelling with codespell ✓ - [x] Test all instructions for clarity and accuracy - [x] Use official spread installation method - [x] Streamline CI section and use correct spread backend ## Latest Update: Refinements Made three targeted improvements based on review feedback: **CI Section Simplified** - Removed detailed list of workflow files (agents can explore .github/workflows/) - Changed to concise statement: "When you push changes, all GitHub Actions workflows should pass" - Focuses on the outcome rather than implementation details **Spread Backend Corrected** - Changed from LXD to multipass backend (LXD is disabled in spread.yaml) - Updated installation: `sudo snap install multipass` - Updated command: `spread multipass:` instead of `spread lxd:` - Simplified instructions (no init step needed for multipass) **Commit Scope Example Improved** - Changed from `feat(TestService)` to `feat(models)` - Better represents actual code structure (models/ directory vs TestService) - More realistic example for the codebase ## Previous Updates **Official Spread Installation** - Changed to `go install github.com/canonical/spread/cmd/spread@latest` (official method) **Instruction Testing and Clarity** - Added Prerequisites section with Python 3.10+, Git, and uv - Clarified `uv run pytest` requires prior `make setup` - Enhanced spread test documentation - More specific pyproject.toml sections - Added guidance on commit scopes **Commit Message Format** - Added scope requirement with examples **Dependencies** - Changed to `uv add` commands **Pydantic Models** - Enhanced validation guidelines **Breaking Changes** - Added comprehensive breaking change patterns section <!-- START COPILOT CODING AGENT SUFFIX --> <details> <summary>Original prompt</summary> > I want to create an agents.md file for this repository so that agents can correctly work on this repo. </details> <!-- START COPILOT CODING AGENT TIPS --> --- 💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey).