Skip to content

Commit

Permalink
Point to rustdoc book in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Specifically request contributors to take a look at the documenting a component section.
  • Loading branch information
dvdsk authored Oct 7, 2024
1 parent a5a49fb commit 02933d4
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ When possible, add integration tests for your new features. Keep in mind:
## Documentation

- 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/`

Expand Down Expand Up @@ -108,9 +109,9 @@ When possible, add integration tests for your new features. Keep in mind:
## Getting Help / Got a question?

- Open an issue on GitHub
- Join the Rust Audio Discord
- Ask questions in your pull request
- Open an issue for guidance/questions
- Join the Rust Audio Discord

## Useful Commands

Expand All @@ -123,9 +124,11 @@ For more detailed information, refer to the full documentation and source code.
## Useful External Resources

- [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/)
- [Rustdoc book](https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html)
- [Rust Performance Book](https://nnethercote.github.io/perf-book/introduction.html)
- [Rust Audio Discord](https://discord.com/invite/8qW6q2k)


## Disclaimer

Please note that the guidelines and practices outlined in this document
Expand Down

0 comments on commit 02933d4

Please sign in to comment.