]> git.proxmox.com Git - rustc.git/blob - src/doc/book/CONTRIBUTING.md
New upstream version 1.56.0~beta.4+dfsg1
[rustc.git] / src / doc / book / CONTRIBUTING.md
1 # Contributing
2
3 We'd love your help! Thanks for caring about the book.
4
5 ## Licensing
6
7 This repository is under the same license as Rust itself, MIT/Apache2. You
8 can find the full text of each license in the `LICENSE-*` files in this
9 repository.
10
11 ## Code of Conduct
12
13 The Rust project has [a code of conduct](http://rust-lang.org/policies/code-of-conduct)
14 that governs all sub-projects, including this one. Please respect it!
15
16 ## Expectations
17
18 Because the book is [printed](https://nostarch.com/rust), and because we want
19 to keep the online version of the book close to the print version when
20 possible, it may take longer than you're used to for us to address your issue
21 or pull request.
22
23 So far, we've been doing a larger revision to coincide with [Rust
24 Editions](https://doc.rust-lang.org/edition-guide/). Between those larger
25 revisions, we will only be correcting errors. If your issue or pull request
26 isn't strictly fixing an error, it might sit until the next time that we're
27 working on a large revision: expect on the order of months or years. Thank you
28 for your patience!
29
30 ## Help wanted
31
32 If you're looking for ways to help that don't involve large amounts of
33 reading or writing, check out the [open issues with the E-help-wanted
34 label][help-wanted]. These might be small fixes to the text, Rust code,
35 frontend code, or shell scripts that would help us be more efficient or
36 enhance the book in some way!
37
38 [help-wanted]: https://github.com/rust-lang/book/issues?q=is%3Aopen+is%3Aissue+label%3AE-help-wanted
39
40 ## Translations
41
42 We'd love help translating the book! See the [Translations] label to join in
43 efforts that are currently in progress. Open a new issue to start working on
44 a new language! We're waiting on [mdbook support] for multiple languages
45 before we merge any in, but feel free to start!
46
47 [Translations]: https://github.com/rust-lang/book/issues?q=is%3Aopen+is%3Aissue+label%3ATranslations
48 [mdbook support]: https://github.com/rust-lang-nursery/mdBook/issues/5