Skip to content

Commit e04aedf

Browse files
KSXGitHubclaude
andauthored
docs(guide/dev): remove even more (#360)
Remove Visibility, Struct Field Ordering, Macros, and `pub use ... as` bullet — these are either standard Rust knowledge, generic best practices, or not used in the codebase. https://claude.ai/code/session_01VE5W68ky3UobBMongN8Dfc Co-authored-by: Claude <noreply@anthropic.com>
1 parent 261e54a commit e04aedf

1 file changed

Lines changed: 0 additions & 20 deletions

File tree

CONTRIBUTING.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,6 @@ pub use error_report::ErrorReport;
6464
pub use event::Event;
6565
```
6666

67-
- Type aliases using `pub use ... as ...` are used to provide semantic alternative names:
68-
69-
```rust
70-
pub use Reflection as DataTreeReflection;
71-
```
72-
7367
### Derive Macro Ordering
7468

7569
When deriving multiple traits, use this order and split across multiple `#[derive(...)]` lines for readability:
@@ -202,12 +196,6 @@ where
202196
HardlinksRecorder: RecordHardlinks<Size, Report> + Sync + ?Sized,
203197
```
204198

205-
### Visibility
206-
207-
- Use `pub` for the public API surface.
208-
- Use `pub(crate)` for items shared within the crate but not exposed externally.
209-
- Default to private for everything else.
210-
211199
### Error Handling
212200

213201
- Define custom error enums with `#[derive(Debug, Display, Error)]` from `derive_more`.
@@ -233,14 +221,6 @@ ExitCode::from(match self {
233221
})
234222
```
235223

236-
### Struct Field Ordering
237-
238-
Order fields logically by purpose, not alphabetically. Group related fields together. Document every public field with `///` comments.
239-
240-
### Macros
241-
242-
Use macros to reduce boilerplate for repetitive patterns (e.g. newtype wrappers, trait impls for multiple numeric types). Keep macros well-scoped and documented.
243-
244224
## Setup
245225

246226
Install the required Rust toolchain and components before running any checks:

0 commit comments

Comments
 (0)