Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions src/compiler/proposals-and-stabilization.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Proposals, Approvals and Stabilization
It is very common to need to gather feedback and approval when contributing to the compiler, either
for permission to proceed with an experiment or refactoring, or when stabilizing a feature. This
document aims to summarise the various processes that the compiler team has for making approval
decisions and when each should be used.
for permission to proceed with an experiment or refactoring, or when stabilizing a feature. Before
submitting substantial changes, we encourage contributors to contact the team on [Zulip] in order to
discuss such changes before submitting them for review. This document aims to
summarise the various processes that the compiler team has for making approval decisions and when
each should be used.

## Approvals
There are three mechanisms that the team can use to approve a proposal (not all approval mechanisms
Expand Down Expand Up @@ -71,16 +73,16 @@ the nature of the proposal, described below.
[major change template]: https://github.com/rust-lang/compiler-team/issues/new?template=major_change.md

#### What kinds of comments should go on a MCP in the compiler-team repo?
Please direct technical conversation to the Zulip stream.
Please direct technical conversation to the [Zulip] stream.

The compiler-team repo issues are intended to be low traffic and used for procedural purposes.

It is recommended that any team member who wishes to "second" a proposal be familiar with the
relevant code. Anyone can note concerns that shouldn't be overlooked.

#### How does one second an MCP or raise an objection?
These types of procedural comments can be left on the issue (it's also good to leave a message in
Zulip). See the previous section. To facilitate a machine parsable scanning of the concerns
These types of procedural comments can be left on the issue (it's also good to leave a message on
[Zulip]). See the previous section. To facilitate a machine parsable scanning of the concerns
please use the following syntax to formally register a concern:

```text
Expand Down Expand Up @@ -414,3 +416,4 @@ See [*Adding ecosystem/integration test jobs/components to rust-lang/rust CI*](.
[ecosystem_testing]: https://rustc-dev-guide.rust-lang.org/tests/ecosystem.html
[compiler-fcp]: https://github.com/rust-lang/team/blob/master/teams/compiler-fcp.toml
[tier-1-target-policy]: https://doc.rust-lang.org/rustc/target-tier-policy.html#tier-1-target-policy
[Zulip]: https://rust-lang.zulipchat.com/#narrow/channel/131828-t-compiler
21 changes: 19 additions & 2 deletions src/how-to-start-contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,23 @@ official website for more resources.
**Please ask questions!** A lot of people report feeling that they are "wasting
expert time", but we do not feel that way. Contributors are important to us.

If you want to contribute substancial changes, we suggest first contacting the team relevant to
these changes. Each teams has their own preferred workflow, please follow the recommended path in
order to have a prior discussion and team buy-in:
- Compiler team: a Major Change Proposal (MCP) or a Request For Comment (RFC) (read more [here][mcp-or-rfc-compiler])
- Rustdoc team: Contact the team on their [Zulip channel][rustdoc-zulip]
- Library team: open an API Change proposal (ACP) on [GitHub][acp-libs] or reach out the team [on Zulip][acp-zulip] (read more [here][libs-docs])
- Bootstrap team: ask in the team [Zulip channel][t-boostrap-zulip]

In case of doubt, feel free to ask on [Zulip][rust-zulip].

[mcp-or-rfc-compiler]: compiler/proposals-and-stabilization.html
[rustdoc-zulip]: https://rust-lang.zulipchat.com/#narrow/channel/266220-t-rustdoc
[t-bootstrap-zulip]: https://rust-lang.zulipchat.com/#narrow/channel/326414-t-infra.2Fbootstrap
[acp-libs]: https://github.com/rust-lang/libs-team/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen
[acp-zulip]: https://rust-lang.zulipchat.com/#narrow/channel/219381-t-libs
[libs-doc]: https://forge.rust-lang.org/libs/maintaining-std.html

## How to start contributing?

The Rust project is quite large and it can be difficult to know which parts of the project need
Expand All @@ -34,7 +51,7 @@ have contributor guides and issues that are marked as needing help or being good

| Project | Contribution guide | Good first issues | Description |
|------------------------------------|-------------------------------------------------|---------------------------------------|-----------------------------------------|
| [Compiler][rustc-repo] | [rustc-dev-guide][rustc-guide] | [Help wanted][rustc-issues] | Rust compiler and associated tooling |
| [Compiler][rustc-repo] | [rustc-dev-guide][rustc-guide] | [Help wanted][rustc-issues] | Rust compiler and associated tooling |
| [Standard library][std-repo] | [std-dev-guide][std-guide] | | Rust standard library |
| [Rustdoc][rustdoc-repo] | [Rustdoc overview][rustdoc-guide] | | Rust documentation generator |
| [Cargo][cargo-repo] | [Cargo Contributor Guide][cargo-guide] | [Good first issues][cargo-issues] | Rust package manager and build system |
Expand All @@ -49,7 +66,7 @@ have contributor guides and issues that are marked as needing help or being good
| [Triagebot][triagebot-repo] | | [Good first issues][triagebot-issues] | Rust automation bot |
| [Rust playground][playground-repo] | | [Help wanted][playground-issues] | Rust online playground |
| [Rustlings][rustlings-repo] | [Rustlings Contribution Guide][rustlings-guide] | [Issue tracker][rustlings-issues] | Rust exercises |
| [MdBook][mdbook-repo] | [MdBook Contribution Guide][mdbook-guide] | [Help wanted][mdbook-issues] | Book generator written in Rust |
| [MdBook][mdbook-repo] | [MdBook Contribution Guide][mdbook-guide] | [Help wanted][mdbook-issues] | Book generator written in Rust |

[rustc-repo]: https://github.com/rust-lang/rust
[rustc-issues]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AE-help-wanted+no%3Aassignee
Expand Down