rust
/
book
mirror of https://github.com/rust-lang/book
1
0
Fork 0
Code Issues Releases Wiki Activity

Add more explanation to CONTRIBUTING about the nostarch directory

This commit is contained in:
Carol (Nichols || Goulding) 2022-06-15 09:02:12 -04:00
parent efa49b56d3
commit 0d36165093
No known key found for this signature in database
GPG Key ID: E907EE5A736F87D4
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
CONTRIBUTING.md
View File

@ -2,6 +2,29 @@
We'd love your help! Thanks for caring about the book.
## Where to Edit
All edits should be made in the `src` directory.
The `nostarch` directory contains snapshots for sending edits to the publishers
of the print version. The snapshot files reflect what has been sent or not, so
they only get updated when edits are sent to No Starch. **Do not submit pull
requests changing files in the `nostarch` directory, they will be closed.**
## Checking for Fixes
The book rides the Rust release trains. Therefore, if you see a problem on
https://doc.rust-lang.org/stable/book, it may already be fixed on the `main`
branch in this repo, but the fix hasn't gone through nightly -> beta -> stable
yet. Please check the `main` branch in this repo before reporting an issue.
Looking at the history for a particular file can also give more information on
how or whether an issue has been fixed or not if you're trying to figure that
out.
Please also search open and closed issues and open and closed PRs before
reporting a new issue or opening a new PR.
## Licensing
This repository is under the same license as Rust itself, MIT/Apache2. You