Skip to content

Add "How to start contributing" page #896

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Kobzol
Copy link
Contributor

@Kobzol Kobzol commented Jun 13, 2025

We have discussed this at the All Hands and on Zulip.

This PR adds a new page to Forge that should serve as a landing page for people that would like to start contributing to Rust. I took some content from the previous (very barebones) "Help Wanted" section in the Forge homepage, and from the "What should I work on?" section from rdg, combined them together, and extended them.

After/if this is merged, I'll go edit rdg to remove things that are not strictly related to the compiler from the "What should I work on?" page, and keep only compiler stuff there, as the general documentation should be in the Forge.

r? @davidtwco

CC @jieyouxu

Rendered

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jun 13, 2025
frontends with HTML/CSS/JS (e.g. [Rustdoc][rustdoc-ui] or [Benchmark suite website][rustc-perf-ui]).
Play to your strengths!
- Improving documentation is possibly one of the easiest starting points for contributions.
Did you find a typo, something that was unclear, or do you miss some useful information on this
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Did you find a typo, something that was unclear, or do you miss some useful information on this
Did you find a typo in user-facing material, something that was unclear, or do you miss some useful information on this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At the end of the sentence I explicitly stated that it's about documentation, but I guess someone could interpret that as also e.g. "comments in rustc" and I know that these kinds of PRs are not ideal :D

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I figured the base is already covered but I wanna be really sure we covered our bases 😆

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Modified the sentence.

Copy link
Member

@BoxyUwU BoxyUwU left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 from me about having this in forge instead of the dev guide

Copy link
Member

@jieyouxu jieyouxu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I think this is a very helpful "entry point" to help discover the contribution guides of not just the compiler / std, but also the toolchain. One tiny nit, but also looks good to me otherwise.

Comment on lines 119 to 120
- You can also help with improving issue trackers of our repositories, by helping with triaging issues
or by reproducing old issues to find out whether they are still valid or not.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: backlink to the Issue Triage page?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted to avoid repo-specific things on this page. But I guess that issue triaging on r-l/r is similar to other repos, so let's link it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants