Repository guide for coding agents
Macro is a document and collaboration app with a Rust backend and a web frontend.
This file is the shared entry point: `AGENTS.md` symlinks
6k28d agoReviewMountCreate a free account to mount
whole thing. Do it right. Do it with tests. Do it with documentation. Do it so well that Ben is genuinely impressed — not politely satisfied, actually impressed. Never offer
6k15d agoReviewMountCreate a free account to mount
body
- **Squash**: Squash WIP commits before opening PR
- **PR requirements**: Run pre-commit, document test coverage, note hardware limitations
## Extended Configuration
See `.claude/agents/`, `.claude/skills/`, `.claude/commands/`, and `.claude/rules/` for
specialized instructions
5.9k50d agoReviewMountCreate a free account to mount
assumption briefly.
---
## Execution Priorities
- Check facts before making claims.
- Verify after changing files, code, documentation, or configuration.
- Keep changes small, reversible, and easy to review.
- Confirm before destructive or high
5.9k7mo agoReviewMountCreate a free account to mount
shared by reference. Be explicit when deep copies are needed.
- See `.claude/rules/config.md`.
### Comments and Documentation
- Add comments only for genuinely non-obvious things: dimension semantics,
parallelism gradient placements
5.9k9d agoReviewMountCreate a free account to mount
responses
- **Validation**: Validate required parameters using `Common.requireArguments()`
- **Consistency**: Follow existing code patterns in `src/modules/`
- **Documentation**: Add JSDoc comments for complex functions
- **Testing**: Test all three encoding formats (json/text/markdown) when adding
5.9k15mo agoReviewMountCreate a free account to mount
access by role/key, not by position.
- **Keep a working log/report.** Maintain a scratch markdown document throughout the task that
records: the problem and a motivating example, road-blockers encountered
5.8k4mo agoReviewMountCreate a free account to mount
reviewer: checks correctness, style, edge cases, test coverage, and regressions. It also reviews all documentation changes and reverts additions that are not significant enough to justify a permanent change
5.8k4mo agoReviewMountCreate a free account to mount
python commands with 'python3'
### 🔌 MCP Server Usage
#### Crawl4AI RAG MCP Server
- **Use for external documentation**: Get docs for Pydantic AI
- **Always check available sources first**: Use `get_available_sources
5.8k17mo agoReviewMountCreate a free account to mount
NEVER code without checking current tasks first.**
## RAG Workflow (Research Before Implementation)
### Searching Specific Documentation:
1. **Get sources** → `rag_get_available_sources()` - Returns list with id, title, url
2. **Find
5.8k17mo agoReviewMountCreate a free account to mount
A file Claude Code reads at the start of every session. It holds the commands, conventions and warnings the agent needs for this project.
Where does it go?
At the repository root. Claude Code also reads CLAUDE.md files in subdirectories when it works there.
What should it contain?
Build and test commands, the project's layout, conventions that aren't obvious from the code, and mistakes to avoid. Short files tend to work better than long ones.
CLAUDE.md or AGENTS.md?
Claude Code reads CLAUDE.md; most other agents read AGENTS.md. Many projects keep one and point the other at it.