mirrors/jj
1
0
Fork 1
mirror of https://github.com/martinvonz/jj.git synced 2024-11-24 15:18:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

docs: fix contributing.md

Browse source 
Summary: This was some fallout from merging #1851; I missed a few changes
I needed to back out for an upcoming diff.

Signed-off-by: Austin Seipp <aseipp@pobox.com>
Change-Id: I1fcdce228dea730ad7c73ad1f05facda
This commit is contained in:
Austin Seipp 2023-07-17 18:38:57 -05:00
parent 9d05e9902a
commit 6c2b2dc909
1 changed files with 3 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/contributing.md
View file

@ -77,12 +77,10 @@ recommended steps.
### Summary
If you already have `rustup` installed, then moving into the source code
directory will install the MSRV for you.
One-time setup:
rustup toolchain add nightly # wanted for 'rustfmt'
rustup toolchain add 1.71 # also specified in Cargo.toml
cargo install cargo-insta
cargo install cargo-watch
cargo install cargo-nextest
@ -91,7 +89,7 @@ During development (adapt according to your preference):
cargo watch --ignore '.jj/**' -s \
'cargo clippy --workspace --all-targets \
&& cargo check --workspace --all-targets'
&& cargo +1.71 check --workspace --all-targets'
cargo +nightly fmt # Occasionally
cargo nextest run --workspace # Occasionally
cargo insta test --workspace # Occasionally
@ -120,6 +118,7 @@ These are listed roughly in order of decreasing importance.
3. Your code will be rejected if it cannot be compiled with the minimal
supported version of Rust ("MSRV"). Currently, `jj` follows a rather
casual MSRV policy: "The current `rustc` stable version, minus one."
As of this writing, that version is **1.71.0**.
4. Your code needs to pass `cargo clippy`. You can also
use `cargo +nightly clippy` if you wish to see more warnings.