rust-lang / rust-lang/rustc-dev-guide

Guide on the "social aspects" of compiler development

Open
#1,061 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

A-meta A-social C-enhancement E-hard T-compiler
Dominant language
HTML
Stars
1.9k
Forks
613
Avg merge
17h 24m
Merged PRs (30d)
39

Description

I think it would be useful to have a short guide on the social aspects of getting into compiler development. Some of this information already exists in the getting started section, but I think it might be good to include this information before mentioning anything technical. I know people with deep compiler experience (e.g., from the C++ world) who have found it hard to contribute not because of technical issues, but because of social issues (e.g., Zulip is very busy and it's hard to know where to even begin).

This would answer questions like the following:

  • How can I get involved?
    • a short description of particular efforts that are pretty beginner friendly (e.g., issue triage, prioritization, compiler perf testing, etc.)
  • Where do I get involved?
    • A short guide to zulip including relevant places to subscribe to (e.g., t-compiler/help, t-compiler/meetings, t-compiler/wg-prioritization, etc.)
  • How do I find good issues to work on?
  • Who can I ask for help?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing getting started section and review the listed Zulip areas: t-compiler/help, t-compiler/meetings, and t-compiler/wg-prioritization. Done means adding a short guide that explains beginner-friendly ways to contribute, where to get involved, how to find issues, and who to ask for help.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.