Skip to content

Commit cb9e74d

Browse files
dduuggclaude
andauthored
Add AGENTS.md and CLAUDE.md for AI coding agent guidance (#98)
* Add AGENTS.md and CLAUDE.md for AI coding agent guidance * Fix inaccuracies in AGENTS.md - Remove redundant heading that repeats the filename - Fix incorrect spec/fixtures/ references where that directory doesn't exist - Fix Claude-specific intro text to be agent-agnostic (pks only) Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
1 parent b360f98 commit cb9e74d

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

AGENTS.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
This file provides guidance to AI coding agents when working with code in this repository.
2+
3+
## What this project is
4+
5+
`codeowners-rs` is a Rust implementation of a CODEOWNERS resolver. It parses CODEOWNERS files and determines ownership of files in a repository, used as both a library and CLI tool.
6+
7+
## Commands
8+
9+
```bash
10+
# Build
11+
cargo build
12+
cargo build --release
13+
14+
# Run all tests
15+
cargo test
16+
17+
# Run a single test by name
18+
cargo test test_name
19+
20+
# Lint
21+
cargo clippy --all-targets --all-features
22+
cargo fmt --all -- --check # check only
23+
cargo fmt --all # apply formatting
24+
25+
# Check compilation without building
26+
cargo check
27+
```
28+
29+
## Architecture
30+
31+
- `src/main.rs` — CLI entry point using `clap`
32+
- `src/lib.rs` — library root; exposes the public API
33+
- `src/ownership.rs` / `src/ownership/` — core ownership resolution logic: parses CODEOWNERS patterns and matches them against file paths
34+
- `src/config.rs` — configuration loading
35+
- `src/runner/` — orchestrates file walking and ownership resolution
36+
- `src/cache/` — caching layer for resolved ownership results
37+
- `src/cli.rs` — CLI command definitions
38+
- Integration tests in `src/common_test.rs`; fixture data used in tests lives alongside test files

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)