Skip to content

Commit becf073

Browse files
prestwichclaude
andcommitted
chore(develop): forward-merge CLAUDE.md and README from main
Brings non-behavioral changes from main into develop: - CLAUDE.md with code quality conventions (ENG-1762) - README.md maintenance-mode note Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 09bedf6 commit becf073

2 files changed

Lines changed: 39 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Signet Node Components
2+
3+
## Branches
4+
5+
The `main` branch is in maintenance and bug-fix mode. The `develop` branch
6+
contains current work.
7+
8+
## Commands
9+
10+
- `cargo +nightly fmt` - format
11+
- `cargo clippy -p <crate> --all-features --all-targets` - lint with features
12+
- `cargo clippy -p <crate> --no-default-features --all-targets` - lint without
13+
- `cargo t -p <crate>` - test specific crate
14+
15+
Pre-commit: clippy (both feature sets where applicable) + fmt. Never use `cargo check/build`.
16+
17+
## Style
18+
19+
- Functional combinators over imperative control flow
20+
- `let else` for early returns, avoid nesting
21+
- No glob imports; group imports from same crate; no blank lines between imports
22+
- Private by default, `pub(crate)` for internal, `pub` for API only; never `pub(super)`
23+
- `thiserror` for library errors, `eyre` for apps, never `anyhow`
24+
- `tracing` for instrumentation: instrument work items not long-lived tasks; `skip(self)` on methods
25+
- Builders for structs with >4 fields or multiple same-type fields
26+
- Tests: fail fast with `unwrap()`, never return `Result`; unit tests in `mod tests`
27+
- Rustdoc on all public items with usage examples; hide scaffolding with `#`
28+
- `// SAFETY:` comments on all unsafe blocks
29+
30+
## Workspace Crates
31+
32+
All crates use `signet-` prefix. Features exist in:
33+
- `signet-blobber`: `test-utils`
34+
- `signet-node-config`: `test_utils`
35+
36+
Other crates (`signet-node`, `signet-node-types`, `signet-rpc`, `signet-db`, `signet-block-processor`, `signet-genesis`, `signet-node-tests`) have no feature flags — lint with `--all-features` only.

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Signet Node Components
22

3+
> **Note:** The `main` branch is in maintenance and bug-fix mode. The
4+
> `develop` branch contains current work.
5+
36
A collection of components for building the Signet node. These components
47
implement core node functionality, but are potentially indepedently useful.
58

0 commit comments

Comments
 (0)