Skip to content

Commit

Permalink
Set expectations a bit more realistically
Browse files Browse the repository at this point in the history
  • Loading branch information
carols10cents committed Jul 27, 2021
1 parent d46db7b commit a07036f
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 7 deletions.
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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:
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/new_translation.md
Original file line number Diff line number Diff line change
@@ -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:
20 changes: 13 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a07036f

Please sign in to comment.