From 0171d1784472f3330ff6c1dd79d236ebfd62cce8 Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 18 Mar 2026 03:41:51 +0000 Subject: [PATCH] docs(guide/dev): remove generic sections from CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- CONTRIBUTING.md | 20 -------------------- 1 file changed, 20 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index daac4586..aa517273 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -64,12 +64,6 @@ pub use error_report::ErrorReport; pub use event::Event; ``` -- Type aliases using `pub use ... as ...` are used to provide semantic alternative names: - -```rust -pub use Reflection as DataTreeReflection; -``` - ### Derive Macro Ordering When deriving multiple traits, use this order and split across multiple `#[derive(...)]` lines for readability: @@ -202,12 +196,6 @@ where HardlinksRecorder: RecordHardlinks + Sync + ?Sized, ``` -### Visibility - -- Use `pub` for the public API surface. -- Use `pub(crate)` for items shared within the crate but not exposed externally. -- Default to private for everything else. - ### Error Handling - Define custom error enums with `#[derive(Debug, Display, Error)]` from `derive_more`. @@ -233,14 +221,6 @@ ExitCode::from(match self { }) ``` -### Struct Field Ordering - -Order fields logically by purpose, not alphabetically. Group related fields together. Document every public field with `///` comments. - -### Macros - -Use macros to reduce boilerplate for repetitive patterns (e.g. newtype wrappers, trait impls for multiple numeric types). Keep macros well-scoped and documented. - ## Setup Install the required Rust toolchain and components before running any checks: