Add CONTRIBUTING.md #443
Add CONTRIBUTING.md #443
Conversation
| We especially welcome documentation PRs. | ||
|
|
||
| As of Rust 1.25 there are differences in how stable and nightly render | ||
| documentation links. Make sure it works on stable, then nightly should be good |
There was a problem hiding this comment.
Another handy tip is to install inotify-tools, then use this command to rebuild documentation automatically on save:
while inotifywait -r -e close_write src/; do cargo doc; done
There was a problem hiding this comment.
That trick is new for me. It is nice, but it does not really seem suitable here in my opinion (and Linux-specific?).
There was a problem hiding this comment.
Yes, linux-specific. Better:
while inotifywait -r -e close_write src/ rand_core/; do cargo doc; done
CONTRIBUTING.md
Outdated
| cargo test --package rand_core --no-default-features | ||
|
|
||
| # Test no_std+alloc support | ||
| cargo test --lib --no-default-features --features alloc |
There was a problem hiding this comment.
point out this requires nightly?
|
|
||
| ```sh | ||
| # Benchmarks (requires nightly) | ||
| cargo bench |
There was a problem hiding this comment.
I thought you recommended this?
export RUSTFLAGS="-C codegen-units=1"
There was a problem hiding this comment.
Yes, but the you fixed the problem in #317.
There was a problem hiding this comment.
I did? And I've still been using the export ever since 😄
|
Updated. |
CONTRIBUTING.md
Outdated
| Thank you for your interest in contributing to Rand! | ||
|
|
||
| The following is a list of notes and tips for when you want to contribute to | ||
| Rand with a PR. |
@vks Would this help with your concerns about removing the section about testing from the readme #439 (comment)?