Skip to content

Commit

Permalink
CONTRIBUTING.md describe error handling in examples
Browse files Browse the repository at this point in the history
  • Loading branch information
dvdsk authored Dec 4, 2024
1 parent 3592cbe commit 09b3e21
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ When possible, add integration tests for your new features. Keep in mind:
- Add inline documentation to all public items.
- Look at the [documenting components](https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html#documenting-components) section of the rustdoc book.
- Generate docs: `cargo doc --open`
- Add an example. That could be as part of the inline documentation or a more complex scenario in `examples/`
- Add an example. That could be as part of the inline documentation or a more complex scenario in `examples/`. The example should not use `unwrap` or `expect` but return `Box<dyn Error>` and use `?`

## Contribution Workflow

Expand Down

0 comments on commit 09b3e21

Please sign in to comment.