Mirrors/rodio
2
0
Fork 0
mirror of https://github.com/RustAudio/rodio synced 2024-12-04 17:29:20 +00:00
Code Issues Projects Releases Packages Wiki Activity

Point to rustdoc book in CONTRIBUTING.md

Browse source 
Specifically request contributors to take a look at the documenting a component section.
This commit is contained in:
David Kleingeld 2024-10-08 00:53:26 +02:00 committed by GitHub
parent a5a49fb5a2
commit 02933d4adf
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
CONTRIBUTING.md
View file

@ -76,6 +76,7 @@ When possible, add integration tests for your new features. Keep in mind:
## Documentation ## Documentation
- Add inline documentation to all public items. - 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` - 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/`
@ -108,9 +109,9 @@ When possible, add integration tests for your new features. Keep in mind:
## Getting Help / Got a question? ## Getting Help / Got a question?
- Open an issue on GitHub - Open an issue on GitHub
- Join the Rust Audio Discord
- Ask questions in your pull request - Ask questions in your pull request
- Open an issue for guidance/questions - Open an issue for guidance/questions
- Join the Rust Audio Discord
## Useful Commands ## Useful Commands
@ -123,9 +124,11 @@ For more detailed information, refer to the full documentation and source code.
## Useful External Resources ## Useful External Resources
- [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/) - [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 Performance Book](https://nnethercote.github.io/perf-book/introduction.html)
- [Rust Audio Discord](https://discord.com/invite/8qW6q2k) - [Rust Audio Discord](https://discord.com/invite/8qW6q2k)
## Disclaimer ## Disclaimer
Please note that the guidelines and practices outlined in this document Please note that the guidelines and practices outlined in this document