rust-lang / rust-lang/rustc-dev-guide
Improve contributing text about subtrees
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
https://rustc-dev-guide.rust-lang.org/contributing.html is really unhelpful.
There's a link for "External Dependencies", but:
- I wouldn't guess that it'd mean "things we have embedded in our repository but should be treated as external dependencies"
- it's just a link to https://rustc-dev-guide.rust-lang.org/external-repos.html
Beyond that, the final page doesn't actually answer my question of "where/how should changes be contributed".
The answer apparently being "In general such changes should be sent to the external repositories even if you find the code in /rust, unless you're making some other change to /rust and doing so would break those files, in which case your commit should include the fixes to them".
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 contributing.html and external-repos.html in the rustc-dev-guide. Read the existing "External Dependencies" link and compare it with the issue's stated question about where changes should be contributed. Done means the contributing guidance clearly identifies embedded external repositories and explains when changes belong upstream versus in /rust.
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
- Mostly clear
- Newbie friendliness
- 42/100