alex/valence
1
0
Fork 0
mirror of https://github.com/italicsjenga/valence.git synced 2024-12-23 14:31:30 +11:00
Code Issues Packages Projects Releases Wiki Activity

Tweak CONTRIBUTING.md

Browse source
This commit is contained in:
Ryan 2022-10-08 18:42:02 -07:00
parent f26f4be1fe
commit c214ffc262
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
CONTRIBUTING.md
View file

@ -3,12 +3,9 @@ or comments.
# What version of Rust should I use?
For _users_ of Valence, the most recent stable version of Rust is required. However, contributors should use a
recent version of nightly (`rustup default nightly`). This implies that unstable `#![feature(...)]` attributes must not
be used.
The reason for nightly is that we are using unstable `rustfmt` settings. Hopefully these settings will not require
nightly in the future.
To _use_ Valence, only the most recent stable version of Rust is required. However, contributors should know that
unstable `rustfmt` settings are enabled in the project. To run `rustfmt` with the nightly toolchain, use
the `cargo +nightly fmt` command.
# What issues can I work on?
@ -52,7 +49,7 @@ fn bar() {}
fn baz() {}
```
This rule applies to types as well.
This guideline applies to types as well.
```rust
pub struct Foo {
@ -116,6 +113,9 @@ Under appropriate circumstances a different naming scheme can be
used. [`Command`](https://doc.rust-lang.org/stable/std/process/struct.Command.html) is a standard type that demonstrates
this.
If a `bar` field exists and no invariants need to be maintained by the getters and setters, it is usually better to make
the `bar` field public.
## Naming Quantities
Quantities of something should be named `foo_count` where `foo` is the thing you're quantifying. It would be incorrect