Skip to content

Commit 73025f6

Browse files
authored
chore: CLAUDE.md -> AGENTS.md (#40)
1 parent d039c0d commit 73025f6

File tree

2 files changed

+26
-255
lines changed

2 files changed

+26
-255
lines changed

AGENTS.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Repository Guidelines
2+
3+
## Project Structure & Module Organization
4+
5+
The CLI entrypoint lives in `src/main.rs` with argument parsing in `src/cli.rs`. Command orchestration sits under `src/commands/`, while domain logic is split across `src/executors/`, `src/analyzer/`, `src/detector/`, and `src/graph/`. Shared helpers are in `src/common.rs` and `src/utils/`. Reporting formats (human, JSON, JUnit, GitHub) live in `src/reports/`. Integration tests sit in `tests/`; repo-level config such as `rustfmt.toml`, `deny.toml`, and `lefthook.yml` is kept at the root.
6+
7+
## Build, Test, and Development Commands
8+
9+
Use `cargo build` for debug builds and `cargo build --release` when profiling. Run `cargo check --all-targets` plus `cargo clippy --all-targets -- -D warnings` before review. Format with `cargo fmt`. Execute `cargo nextest run --profile ci --cargo-profile ci` for the canonical test suite; keep `cargo test` for narrow repros. Guard dependencies with `cargo deny check`. For manual verification, `cargo run -- inspect` scans for cycles and `cargo run -- spectacle` previews graph output.
10+
11+
## Coding Style & Naming Conventions
12+
13+
Follow Rust 2021 defaults enforced by `rustfmt` (2-space indentation). Modules and files use snake_case; types and traits use PascalCase; public constants belong in `src/constants.rs`. Avoid `unwrap`; return typed errors with `thiserror` and surface them through `miette::Result`. Document subtle behaviors sparingly with short comments.
14+
15+
## Testing Guidelines
16+
17+
Place unit tests beside implementations via `mod tests`. Integration coverage lives in `tests/`, named `<feature>_test.rs`. Use `assert_cmd`, `predicates`, and `tempfile` for CLI scenarios, and match on concrete error variants. Every feature should pass `cargo nextest run --profile ci --cargo-profile ci`; refresh any fixtures or snapshots you modify.
18+
19+
## Commit & Pull Request Guidelines
20+
21+
Adopt Conventional Commit prefixes seen in history (e.g., `feat:`, `fix:`, `chore(deps):`). Keep subject lines under 72 characters. Each PR should link issues when available, list manual verification steps, and attach screenshots or CLI output for visualization changes. Confirm `cargo check`, `cargo nextest`, `cargo fmt`, and `cargo clippy` pass locally before requesting review, and call out intentional skips.
22+
23+
## Agent-Specific Tips
24+
25+
Coordinate with maintainers before altering `flake.nix` or `lefthook.yml`. When adding reports or executors, define toggles in `src/config/` and document them in `README.md`. Regenerate diagrams with `cargo run -- spectacle` and commit changed artifacts.

CLAUDE.md

Lines changed: 0 additions & 255 deletions
This file was deleted.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md

0 commit comments

Comments
 (0)