Rustc-dev-guide: Move relevant content from the forge

Created on 14 May 2018  路  21Comments  路  Source: rust-lang/rustc-dev-guide

Currently, the forge has a lot of useful content that could be moved over.

It would be good to move each of these over to the relevant part of the rustc guide and delete the corresponding forge page (by making a PR on https://github.com/rust-lang-nursery/rust-forge).

EDIT: according to https://github.com/rust-lang-nursery/rustc-guide/issues/133#issuecomment-429571177

Easy help wanted

Most helpful comment

@mark-i-m can I work on Compiler Bug Fix Procedure(5th in the list) ?

All 21 comments

Is this still needed? I'd be happy to help with this with some pointers!

Sorry for the late reply. Yep, this is still needed.

I would suggest picking one of the documents above and making a PR to move it over. Just let me know which one you are interested in. Feel free to ask questions :)

Before you put a lot of work into one of the documents, I would recommend doing a quick search through the book to make sure the topic is not already documented, though.

About the infra & backporting pages, I think those should be kept on the forge: those are used mostly by the infra/release teams, not by rustc contributors.

@mark-i-m can I work on Stabilization guide (3rd one)?

@rajcspsg about the stabilization guide, there is additional content in a forge PR.

@rajcspsg That would be great :)

How about a new chapter after the closing conventions chapter?

@mark-i-m could you please provide me more details on conventions chapter (i..e, which pointer in the description)?

@rajcspsg I was thinking of something like this:

  # Summary

  - [About this guide](./about-this-guide.md)
  - [About the compiler team](./compiler-team.md)
  - [How to build the compiler and run what you built](./how-to-build-and-run.md)
      - [Build and Install distribution artifacts](./build-install-distribution-artifacts.md)
      - [Documenting Compiler](./compiler-documenting.md)
  - [Coding conventions](./conventions.md)
+ - [Stabilizing Features](./stabilization.md)
  - [Walkthrough: a typical contribution](./walkthrough.md)
  - [The compiler testing framework](./tests/intro.md)
  - [The compiler testing framework](./tests/intro.md)

Does that answer your question?

Yeah. I got it now :)
Thanks @mark-i-m @pietroalbini
I will go through the documentation and let you know if I have any questions.

@mark-i-m Can I take Implementing new features part of this issue?

@rajcspsg Sounds good :+1:

@rajcspsg I also forgot about #98. Do you mind also adding the things Niko mentions in that issue as part of your PR?

@mark-i-m Sure I will do that !!!

@mark-i-m can I work on Compiler Bug Fix Procedure(5th in the list) ?

cc @spastorino @nikomatsakis

@rajcspsg I think there are some ongoing discussions about changing the role of the forge, but I am out of town this week so I don鈥檛 know what was decided. Perhaps @spastorino can advise?

The idea is that forge should be linked from Rust website and be mainly about procedures. rustc-guide should be pretty focused on "what you need to hack on rustc".

@rajcspsg if you're interested in contributing to rustc-guide in general, I'd recommend you to join Zulip and visit this stream https://rust-lang.zulipchat.com/#narrow/stream/196385-t-compiler.2Fwg-learning

@spastorino It seems like the 3 remaining topics in the OP checklist are still relevant and should be moved to the guide. Do you agree?

@mark-i-m yes :+1:, do you want to create issues for them?. I'm planning on starting one or more Project to track some things in a different way but from Project I can link to all these issues we are talking about.

@spastorino I guess I'm not sure. Do we want to make the issues that fine-grained? I'm wary of having information in too many places, as it will be hard to keep everything up to date.

@mark-i-m I think you're right. I'd leave the checklist as is in this issue and not open more issues.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

phansch picture phansch  路  7Comments

alexreg picture alexreg  路  3Comments

crlf0710 picture crlf0710  路  3Comments

mark-i-m picture mark-i-m  路  3Comments

mark-i-m picture mark-i-m  路  8Comments