collin/anvil
feat/web-edit-attachments-usage / CLAUDE.md
RenderedSource
| 1 | # anvil |
| 2 | |
| 3 | A minimal, self-hosted git forge in Rust, built on gix (gitoxide). |
| 4 | |
| 5 | ## Design rules |
| 6 | |
| 7 | - **Pure gitoxide — never the git binary.** The product (server, CI broker, |
| 8 | mirroring, deploy image) must not invoke or depend on a `git` executable. |
| 9 | When gix lacks a capability, implement the protocol on gix plumbing instead |
| 10 | of shelling out — e.g. gix can't push yet, so `anvil-git/src/push.rs` speaks |
| 11 | the send-pack wire format itself (with `gitserver-core` covering the server |
| 12 | side). Tests may use the git CLI, but only as a fixture/interop check, never |
| 13 | on the code path under test. |
| 14 | |
| 15 | Dev setup: `git config core.hooksPath .githooks` — the pre-commit hook runs |
| 16 | `cargo +nightly fmt` (nightly, for the unstable options in rustfmt.toml), |
| 17 | `cargo sort-derives` (`cargo install cargo-sort-derives`), and |
| 18 | `cargo clippy --workspace --all-targets -- -D warnings`. |
| 19 | |
| 20 | Current status, resume notes, the agreed next steps (a/b/c), and the roadmap live |
| 21 | in the TODO. Read it first: |
| 22 | |
| 23 | @TODO.md |