rust-lang / rust-lang/rustc_codegen_gcc
Improve the documentation for new contributors
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Rust
- Stars
- 1.2k
- Forks
- 105
- Avg merge
- 8h 20m
- Merged PRs (30d)
- 14
Description
Add a guide for new contributors. Topic ideas would include:
- Document the way to run a specific test (including the ones in
tests/run). - Document an existing function (explaining why it does things like casting values) to explain core concepts.
- Point to relevant documentation in the Rustc dev guide?
- Perhaps have a "Getting started" contribution guide to explain how a potential contributor can show their interest so that we can guide them (like join IRC/Zulip to ask us where to start)?
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 reviewing the test layout, especially tests/run, and the relevant Rustc dev guide material. Define a contributor guide covering how to run specific tests, an existing function's core concepts, and how potential contributors can ask where to start. Done means the guide is added and all proposed onboarding topics are addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100