docs: Add AGENTS.md and CLAUDE.md for AI coding assistants#1271
docs: Add AGENTS.md and CLAUDE.md for AI coding assistants#1271prestist wants to merge 1 commit intocoreos:mainfrom
Conversation
AGENTS.md provides a concise repository specification for tool-agnostic AI coding assistants (OpenCode, Cursor, etc). CLAUDE.md imports AGENTS.md and adds Claude Code-specific workflows.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces AGENTS.md and CLAUDE.md to provide comprehensive project documentation and workflow instructions for AI agents. The review feedback recommends replacing raw cargo commands with the project's defined make targets (make test, make lint, make fmt) to ensure consistency with required build flags and simplify maintenance.
| - **Mock tests**: Separate `mock_tests.rs` per provider using `mockito` for HTTP mocking | ||
| - **Fixture tests**: `tests.rs` files loading data from `tests/fixtures/` (kubevirt, proxmoxve) | ||
| - **Fixture validation**: `python3 tests/fixtures/validate.py` checks against upstream schemas | ||
| - Run `cargo test --all-targets` before submitting changes |
There was a problem hiding this comment.
The test command here is inconsistent with the make test command defined on line 43 and in the Makefile. The project's Makefile explicitly uses the --release flag for tests. It is better to use the make target to ensure consistency and that all project-specific flags are applied.
| - Run `cargo test --all-targets` before submitting changes | |
| - Run make test before submitting changes |
| cargo test --all-targets | ||
| cargo clippy --all-targets -- -D warnings | ||
| cargo fmt -- --check -l |
There was a problem hiding this comment.
Instead of repeating raw cargo commands, it is recommended to use the make targets defined in the Makefile. This ensures the AI agent uses the exact flags (like --release for tests or specific clippy/fmt arguments) required by the project and makes the documentation easier to maintain.
| cargo test --all-targets | |
| cargo clippy --all-targets -- -D warnings | |
| cargo fmt -- --check -l | |
| make test | |
| make lint | |
| make fmt |
1 participant
AGENTS.md provides a concise repository specification for tool-agnostic AI coding assistants (OpenCode, Cursor, etc). CLAUDE.md imports AGENTS.md due to claude not looking for AGENTS.md automatically.