Skip to content
This repository was archived by the owner on Apr 13, 2026. It is now read-only.

Commit 3a00c38

Browse files
committed
docs: add session learnings to CLAUDE.md
Add dependency management gotchas, CI workflow notes, code pattern reminders, and git tips discovered during comprehensive codebase audit. Signed-off-by: UncleSp1d3r <unclesp1d3r@evilbitlabs.io>
1 parent c614ddb commit 3a00c38

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,27 @@
11
@AGENTS.md
2+
3+
## Session Learnings
4+
5+
### Dependency Management
6+
7+
- Cargo.toml may be reformatted by `cargo-sort` pre-commit hook — run `just ci-check` twice if it fails on "Cargo.toml is sorted"
8+
- Never bump `rand` or `rand_chacha` without updating all generator code — rand 0.9→0.10 is a breaking API change
9+
- Always verify the original code compiles (`git stash && cargo check`) before "fixing" reported build issues
10+
- Cargo.lock is checked in — restore it with `git checkout HEAD -- Cargo.lock` if dep resolution changes unexpectedly
11+
12+
### CI Workflow
13+
14+
- `just ci-check` is the mandatory gate before commits — includes pre-commit hooks, clippy, tests, coverage, and dist-plan
15+
- `dist-plan` may fail due to `cargo-dist` version mismatch — this is an environment issue, not a code issue
16+
- Pre-commit hooks auto-fix files (cargo-sort, fmt) — a second run should pass after auto-fixes
17+
18+
### Code Patterns
19+
20+
- Error message strings are asserted in both unit tests (`src/`) and integration tests (`tests/`) — changing an error message requires updating both
21+
- `VlanConfig` fields are `pub` — mutations bypass `new()` validation (known tech debt, tracked in issue #105)
22+
- XML template path (`xml/template.rs`) is the production code path; `xml/{builder,engine,injection,generator}.rs` are unused
23+
24+
### Git
25+
26+
- Default push may try all tracking branches — `git push origin <branch>` to push only the feature branch
27+
- DCO sign-off required: `git commit -s`

0 commit comments

Comments
 (0)