Copilot Instructions
## Code Style and Formatting
### Function Documentation
#### Python
Every function **must** include a docstring **inside** the function body, immediately after the
`def` line. Use the following format:
```python
primary source (SEC filing, company IR, FRED, exchange data, or the user's own document), recompute derived numbers, mark ✅ verified / ⚠️ mismatch / ❓ unverifiable, and re-issue the report with inline citations
GitHub Copilot Review Instructions for Magda
This document defines code review guidelines for the Magda project, a JUCE/C++ audio DAW framework. Reviews should focus on critical bugs, performance improvements
Claude Code AI Agent Instructions
This document provides essential guidance for AI coding agents working in the Claude Code repository. It outlines the architecture, workflows, and conventions to ensure productive
inherently unclear or abstract that a comment is necessary.
**You never write any xml documentation comments** They are exceptionally expensive to generate. If needed, the user will
Handle malformed archives gracefully without crashes
- Implement proper resource cleanup (dispose streams, file handles)
## Documentation
- Add XML documentation comments for public APIs
- Keep README.md updated with new features or changes
over what you are about to commit. |
| "It is only a docs change" | Documentation that is wrong is worse than documentation that is missing, because somebody acts
mark the task complete with failing tests. |
| **Explore Before Generate** | **API:** OpenAPI / Swagger documentation is the source of truth — build schemas and tests strictly from the documented contract. **Only when
feature or an idea
1. Start from carefully reading the CLAUDE.md and README.md documents to get the context of this project
2. Then, read the docs/dev/SPECIFICATION.md document to deep dive
Contract & cache invariants**: a change that silently alters an external contract
or breaks a documented rule.
- **Test strategy**: exported behaviour — a CLI flag, public function, persisted schema,
artifact layout — landing
decisions** - Explain WHY a service or pattern was chosen, including tradeoffs
5. **Link to documentation** - Reference official Microsoft Learn documentation
6. **Consider organizational context** - Ask about team skills, budget, compliance
repo test structure.
- Always make sure all tests pass before submitting changes.
- Always ensure documents and code are linted before submitting.
- Do multiple rounds of review and refinement
Corporation.
// Licensed under the MIT License.
```
- All public methods and classes should have XML documentation comments.
- No change should introduce a breaking change unless an exception is otherwise noted
carried a
"keep these in sync" comment, drifted apart anyway, and both went on documenting
`src/agentor/agenthub/`, `src/agentor/memory/` and `src/agentor/agents/a2a.py`
long after those paths were deleted. A pointer cannot go stale
written in English. This applies to:
- All rule and instruction files in `instructions/`
- All documentation and code comments intended for contributors
## Development code generation
When working with C# code, follow