Skip to content

Commit 4a1cb26

Browse files
baldawarishiclaude
andauthored
docs: rewrite AGENTS.md with conventional commits and lean guidance (#13)
## Summary - Rewrites AGENTS.md from a 14-line CLAUDE.md duplicate into a lean, agent-focused guide (~19 lines) - Adds Conventional Commits guidance (requested in #7 by @alecthomas) - Adds `just run` and `just test-one` recipes to Justfile so all commands live in one place - Adds gotchas (consolidate into KNOWN_AGENTS, keep it fast) and a self-improving maintenance line ## Test plan - [x] `just lint` passes - [x] `just test` passes (all 20 tests) - [ ] Review AGENTS.md content for completeness and tone 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 76c033f commit 4a1cb26

File tree

2 files changed

+21
-8
lines changed

2 files changed

+21
-8
lines changed

AGENTS.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
1-
This is a Rust project.
1+
This is a Rust project. Hermit manages toolchains, Just manages commands.
22

3-
The script ./scripts/aittributor is a convenience script that compiles and executes aittributor. ALWAYS use this to run, NEVER manually compile and run.
3+
Run `just` to see all available commands. Use `just run` to build and runNEVER manually compile and run. Use only libraries already in Cargo.toml.
44

5-
We use:
6-
- Hermit to manage toolchains and tools.
7-
- Just for command running.
5+
README.md describes the design of this command-line tool. ALWAYS keep it up to date with features.
86

9-
Use the libraries already added in @Cargo.toml.
7+
## Commits and PRs
108

11-
@README.md describes the design of this command-line tool.
9+
Use Conventional Commits for commit messages and PR titles. CI lints PR titles.
1210

13-
ALWAYS keep the README up to date with features.
11+
## Gotchas
12+
13+
- Consolidate all agent data into `KNOWN_AGENTS` in `src/agent.rs`.
14+
- This tool runs on every commit — keep it fast (1-second hard timeout).
15+
16+
## Maintenance
17+
18+
You may update this file to correct mistakes.

Justfile

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,18 @@ fmt:
1414
build:
1515
cargo build --release
1616

17+
# Build and run aittributor
18+
run *ARGS:
19+
./scripts/aittributor {{ARGS}}
20+
1721
# Test the project
1822
test:
1923
cargo test --all-features
2024

25+
# Run a single test by name
26+
test-one NAME:
27+
cargo test {{NAME}} --all-features
28+
2129
# Generate release notes from git log since previous tag
2230
release-notes tag="":
2331
#!/usr/bin/env bash

0 commit comments

Comments
 (0)