Skip to content

docs(guide/dev): remove even more #360

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KSXGitHub merged 1 commit into from
Mar 18, 2026
+0 −20
Merged

docs(guide/dev): remove even more #360

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 0 additions & 20 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -202,12 +196,6 @@ where
HardlinksRecorder: RecordHardlinks<Size, Report> + 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`.
Expand All @@ -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:
Expand Down