Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: recommend use of nightly Rust for local development #4601

Closed
wants to merge 2 commits into from
Closed

docs: recommend use of nightly Rust for local development #4601

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70498e7
Add nightly suggestion
thomaseizinger Oct 9, 2023
a5f02e3
Merge branch 'master' into docs/recommend-nightly
thomaseizinger Oct 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ The PR title, which will become the commit message after the squashing process,
When making user-facing changes, it is important to include corresponding entries in the changelog, providing a comprehensive summary for the users.
For detailed instructions on how to write changelog entries, please refer to the documentation in [`docs/release.md`](https://github.com/libp2p/rust-libp2p/blob/master/docs/release.md).


### Merging of PRs is automated

To streamline our workflow, we utilize Mergify and the "send-it" label.
Expand All @@ -38,3 +37,8 @@ Please refrain from making further commits after the "send-it" label has been ap

We have a lot of automated CI checks for common errors.
Please treat our CI as a self-service platform and try to fix any issues before requesting a review.

### Use nightly Rust for better diagnostics

We recommend the use of nightly Rust during local development for better diagnostics.
Our CI will ensure that all code correctly builds on stable Rust and adheres to our MSRV requirements.