Skip to content

Commit e7e8298

Browse files
MRNIUclaude
andcommitted
docs: add CLAUDE.md symlink and promote git signoff convention
- CLAUDE.md → AGENTS.md symlink (Claude Code auto-loads CLAUDE.md) - Move git commit conventions from NOTES to CONVENTIONS section - Make --signoff requirement explicit and prominent - Add subagent dispatch note for signoff Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Niu Zhihong <zhihong@nzhnb.com>
1 parent 42c8a68 commit e7e8298

2 files changed

Lines changed: 7 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,12 @@ docs/rust-rewrite/ # Design docs, phase plans (P0-P7)
5858

5959
> Full Rust coding conventions: `docs/rust-rewrite/00-概述.md` §9
6060
61+
### Git
62+
- **Commit 格式**: `<type>(<scope>): <subject>` — type: feat/fix/refactor/test/docs/chore
63+
- **Sign-off 必须**: 每条 commit 必须使用 `git commit --signoff`(DCO 签署),**不可省略**
64+
- **Subagent 派发时**:给 subagent 的 commit 指令中也必须包含 `--signoff`
65+
66+
### Rust
6167
- **Language**: Rust nightly, `#![no_std]`, `#![no_main]`, edition 2024
6268
- **Naming**: `snake_case` functions/methods, `PascalCase` types/traits/enums, `SCREAMING_SNAKE_CASE` constants
6369
- **Formatting**: `rustfmt.toml` (100 char width), enforce via `cargo fmt`
@@ -117,7 +123,6 @@ cargo doc --no-deps
117123
- Boot chains differ: riscv64 (U-Boot SPL→OpenSBI→U-Boot), aarch64 (U-Boot→ATF→OP-TEE)
118124
- aarch64 needs two serial terminal tasks (::54320, ::54321) before `cargo xtask run --arch aarch64`
119125
- Unit tests run on x86_64 host only (`cargo test`) — system tests use QEMU (`cargo xtask run`)
120-
- Git commits: `<type>(<scope>): <subject>` with `--signoff`
121126
- Debug: use `cargo xtask debug` + GDB, QEMU logs in build output
122127
- Design docs: `docs/rust-rewrite/00-概述.md` is the master reference for all design decisions
123128
- Phase plans: `docs/rust-rewrite/P0-P7` for step-by-step implementation guides

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)