diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..c1157112fa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,13 @@ +--- +name: Bug report +about: Create a report to help us improve +--- + +- [ ] I have checked the latest `main` branch to see if this has already been fixed +- [ ] I have searched existing issues and pull requests for duplicates + +URL to the section(s) of the book with this problem: + +Description of the problem: + +Suggested fix: diff --git a/.github/ISSUE_TEMPLATE/new_translation.md b/.github/ISSUE_TEMPLATE/new_translation.md new file mode 100644 index 0000000000..c7bdc06edd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new_translation.md @@ -0,0 +1,7 @@ +--- +name: New translation +about: Let us know of a new language translation you're working on +--- + +Language your translation is for: +URL to the repo where you're working: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8710bd2b2f..e1c7e186f4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,13 +13,19 @@ repository. The Rust project has [a code of conduct](http://rust-lang.org/policies/code-of-conduct) that governs all sub-projects, including this one. Please respect it! -## Review - -Our [open pull requests][pulls] are new chapters or edits that we're -currently working on. We would love if you would read through those and make -comments for any suggestions or corrections! - -[pulls]: https://github.com/rust-lang/book/pulls +## Expectations + +Because the book is [printed](https://nostarch.com/rust), and because we want +to keep the online version of the book close to the print version when +possible, it may take longer than you're used to for us to address your issue +or pull request. + +So far, we've been doing a larger revision to coincide with [Rust +Editions](https://doc.rust-lang.org/edition-guide/). Between those larger +revisions, we will only be correcting errors. If your issue or pull request +isn't strictly fixing an error, it might sit until the next time that we're +working on a large revision: expect on the order of months or years. Thank you +for your patience! ## Help wanted diff --git a/README.md b/README.md index 54e92f6f8f..7b1236b451 100644 --- a/README.md +++ b/README.md @@ -73,6 +73,18 @@ kinds of contributions we're looking for. [contrib]: https://github.com/rust-lang/book/blob/master/CONTRIBUTING.md +Because the book is [printed](https://nostarch.com/rust), and because we want +to keep the online version of the book close to the print version when +possible, it may take longer than you're used to for us to address your issue +or pull request. + +So far, we've been doing a larger revision to coincide with [Rust +Editions](https://doc.rust-lang.org/edition-guide/). Between those larger +revisions, we will only be correcting errors. If your issue or pull request +isn't strictly fixing an error, it might sit until the next time that we're +working on a large revision: expect on the order of months or years. Thank you +for your patience! + ### Translations We'd love help translating the book! See the [Translations] label to join in