rust-lang/rustc-dev-guide

master tracking issue

nikomatsakis opened this issue · 2 comments

nikomatsakis commented

This tracking issue contains links to the issues for all the chapters and subsections of the book. It is also the main place to come to if you're looking to get started on contributing.

How to contribute

Skim down the list below and find a chapter that looks interesting to you. It should have a link to an associated tracking issue. Click on that link and leave a comment there saying you'd like to help out (and/or start writing something).

In general, if you don't know how the compiler works, that is not a problem! In that case, what we will do is to schedule a bit of time for you to talk with someone who does know the code, or who wants to pair with you and figure it out. Then you can work on writing up what you learned. Just cc @nikomatsakis for help.

If you think there is a missing section please file an issue and we will consider how to fit into this outline.

The outline

  • How to build the compiler and run what you built (#8)
  • Walkthrough: a typical contribution (#237)
  • Using the compiler testing framework (#10)
  • Debugging the compiler (#11)
  • Conventions used in the compiler (#12)
  • The parser (#13)
  • Diagnostics: reporting errors and lints (#14)
  • Macro expansion (#15)
  • Name resolution (#16)
  • HIR and HIR lowering (#17)
  • Representing types (ty module in depth)
  • Type inference
  • Trait resolution (#52, #70 )
  • Type checking
  • MIR construction
  • MIR borrowck (#67 )
  • MIR optimizations
  • MIRI (#30, #45)
  • trans: generating LLVM IR (#89)
  • Glossary
nikomatsakis commented

Note: this conversation is locked to keep this tracking issue tidy.

mark-i-m commented

@nikomatsakis I think this issue is getting rather out of date. At this point, it seem like all of these topics have made it into the table of contents of the book; it's just a matter of fleshing out the chapters.

Should we close this issue?