rust-lang / rust-lang/rustc-dev-guide
Difficult to find 'How to structure your PR'
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
When I was looking for info about how to structure my PR, I checked out the "A typical contribution" section of the Guide to Rustc development book, because based on the available sections, that seemed the most likely. I wouldn't have thought to look in the Coding Conventions sections (I wouldn't consider a PR a piece of code is why I'm guessing)
Originally posted by @alex-griffiths in https://rust-lang.zulipchat.com/#narrow/stream/122651-general/topic/Creating.20a.20pull.20request/near/207373580.
Contributor guide
No contributing guide indexed for this repository
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 with the Guide to Rustc development book, especially the “A typical contribution” and “Coding Conventions” sections mentioned in the issue. Determine where guidance on structuring a pull request should be discoverable, then update the relevant navigation or wording so contributors can find it without guessing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100