rust-lang / rust-lang/rust-by-example
If and how to PR a great deal of changes
Nobody has claimed this yet.
- Dominant language
- Handlebars
- Stars
- 8.1k
- Forks
- 1.6k
- PR merge metrics
- No merged PRs in 30d
Description
I ended up reviewing most of this book, and have come to the conclusion that the book needs a non-trivial number of changes to bring it more up-to-date and to correct some inaccuracies.
If you (the maintainers) wish, I can see about turning my notes into PRs. But as you can see, there are a lot of notes. My questions are
- Would this be productive -- can you entertain a large number of changes?
- If so, how best should the PRs be made -- per page, per chapter?
- Is it okay restructure sections/pages or are you trying to maintain the page names, etc?
Alternatively, feel free to make use of the notes without my further involvement.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the linked rbe-notes README.md and the issue discussion about handling the proposed changes. Done means the maintainers have agreed whether to accept the updates and how to divide them into pull requests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100