swarm repositories / source
aboutsummaryrefslogtreecommitdiff
path: root/AGENTS.md
diff options
context:
space:
mode:
authormain <main@swarm.moe>2026-04-17 22:08:47 -0400
committermain <main@swarm.moe>2026-04-17 22:08:47 -0400
commit372d366f541f4560a304d4d374bebc31aec6e8c3 (patch)
tree0ee6a8f869fd31cb33b7031c5991c17a1dfdf79d /AGENTS.md
parent8048d67e5917b771be9aa819094aebf3936d0e98 (diff)
downloadrust_starter-372d366f541f4560a304d4d374bebc31aec6e8c3.zip
Install Rust style doctrine
Diffstat (limited to 'AGENTS.md')
-rw-r--r--AGENTS.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/AGENTS.md b/AGENTS.md
index 9ea771b..e08e08c 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -1,5 +1,10 @@
This repo is the source of truth for bootstrapping or ratcheting Rust lint posture.
+Read [docs/rust-style-doctrine.md](/home/main/programming/projects/rust_starter/docs/rust-style-doctrine.md)
+before meaningful Rust style decisions. New and retrofitted Rust projects should
+link to that doctrine from their own `AGENTS.md` so future agents inherit the
+same taste surface.
+
Choose exactly one surface:
- Fresh bootstrap: read [docs/bootstrap-fresh.md](/home/main/programming/projects/rust_starter/docs/bootstrap-fresh.md) and adapt the files under [template/fresh](/home/main/programming/projects/rust_starter/template/fresh).
@@ -10,6 +15,7 @@ House rules:
- Keep lint semantics in root `Cargo.toml`; keep runners, CI, and editor config orchestration-only.
- Make every member crate opt into `[lints] workspace = true`.
- Pin an exact stable toolchain in `rust-toolchain.toml`.
+- Install a target `AGENTS.md` link to [docs/rust-style-doctrine.md](/home/main/programming/projects/rust_starter/docs/rust-style-doctrine.md).
- Prefer `#[expect(..., reason = "...")]` for temporary local suppressions.
- Retrofit is ratchet work: preserve stricter local policy and justified local carve-outs; do not blindly paste the template.