Skip to content

Commit 362e4f2

Browse files
authored
docs(guide/dev): remove some sections from CONTRIBUTING.md
1 parent ee5ddc0 commit 362e4f2

1 file changed

Lines changed: 1 addition & 19 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,6 @@ where
211211
### Error Handling
212212

213213
- Define custom error enums with `#[derive(Debug, Display, Error)]` from `derive_more`.
214-
- Mark error enums as `#[non_exhaustive]`.
215214
- Minimize `unwrap()` in non-test code — use proper error propagation. `unwrap()` is acceptable in tests and for provably infallible operations (with a comment explaining why). When deliberately ignoring an error, use `.ok()` with a comment explaining why.
216215

217216
```rust
@@ -223,22 +222,9 @@ pub enum RuntimeError {
223222
}
224223
```
225224

226-
### Documentation Comments
227-
228-
- Use `///` doc comments for all public types, traits, functions, and fields.
229-
- Use `//!` module-level doc comments at the top of `lib.rs` and significant modules.
230-
- Include usage examples with `/// ```no_run` blocks for key public APIs.
231-
- Reference related types with `[`backtick links`](crate::path)` syntax.
232-
233-
### Feature Gating
234-
235-
- Use `#[cfg(feature = "...")]` for optional functionality (e.g., `json`, `cli`).
236-
- Use `#[cfg(unix)]` for POSIX-specific code.
237-
- Use `#[cfg_attr(feature = "json", derive(Deserialize, Serialize))]` for conditional derives.
238-
239225
### Pattern Matching
240226

241-
Use exhaustive matching. When mapping enum variants to values, prefer the concise wrapping style:
227+
When mapping enum variants to values, prefer the concise wrapping style:
242228

243229
```rust
244230
ExitCode::from(match self {
@@ -255,10 +241,6 @@ Order fields logically by purpose, not alphabetically. Group related fields toge
255241

256242
Use macros to reduce boilerplate for repetitive patterns (e.g. newtype wrappers, trait impls for multiple numeric types). Keep macros well-scoped and documented.
257243

258-
### Warnings Policy
259-
260-
The crate uses `#![deny(warnings)]` — all warnings are treated as errors. Code must compile warning-free.
261-
262244
## Setup
263245

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

0 commit comments

Comments
 (0)