330 lines
18 KiB
HTML
330 lines
18 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>About the compiler team - Rust Compiler Development Guide</title>
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
<meta name="description" content="A guide to developing the Rust compiler (rustc)">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#ffffff">
|
|
|
|
<link rel="icon" href="favicon.svg">
|
|
<link rel="shortcut icon" href="favicon.png">
|
|
<link rel="stylesheet" href="css/variables.css">
|
|
<link rel="stylesheet" href="css/general.css">
|
|
<link rel="stylesheet" href="css/chrome.css">
|
|
<link rel="stylesheet" href="css/print.css" media="print">
|
|
|
|
<!-- Fonts -->
|
|
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
|
|
<link rel="stylesheet" href="fonts/fonts.css">
|
|
|
|
<!-- Highlight.js Stylesheets -->
|
|
<link rel="stylesheet" id="highlight-css" href="highlight.css">
|
|
<link rel="stylesheet" id="tomorrow-night-css" href="tomorrow-night.css">
|
|
<link rel="stylesheet" id="ayu-highlight-css" href="ayu-highlight.css">
|
|
|
|
<!-- Custom theme stylesheets -->
|
|
|
|
|
|
<!-- Provide site root and default themes to javascript -->
|
|
<script>
|
|
const path_to_root = "";
|
|
const default_light_theme = "light";
|
|
const default_dark_theme = "navy";
|
|
</script>
|
|
<!-- Start loading toc.js asap -->
|
|
<script src="toc.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="body-container">
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|
<script>
|
|
try {
|
|
let theme = localStorage.getItem('mdbook-theme');
|
|
let sidebar = localStorage.getItem('mdbook-sidebar');
|
|
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|
}
|
|
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|
}
|
|
} catch (e) { }
|
|
</script>
|
|
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|
<script>
|
|
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
|
|
let theme;
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|
const html = document.documentElement;
|
|
html.classList.remove('light')
|
|
html.classList.add(theme);
|
|
html.classList.add("js");
|
|
</script>
|
|
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script>
|
|
let sidebar = null;
|
|
const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
|
if (document.body.clientWidth >= 1080) {
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|
sidebar = sidebar || 'visible';
|
|
} else {
|
|
sidebar = 'hidden';
|
|
}
|
|
sidebar_toggle.checked = sidebar === 'visible';
|
|
html.classList.remove('sidebar-visible');
|
|
html.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<!-- populated by js -->
|
|
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
|
<noscript>
|
|
<iframe class="sidebar-iframe-outer" src="toc.html"></iframe>
|
|
</noscript>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
|
<div class="sidebar-resize-indicator"></div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
<div class="page">
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|
<div id="menu-bar" class="menu-bar sticky">
|
|
<div class="left-buttons">
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</label>
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|
<i class="fa fa-paint-brush"></i>
|
|
</button>
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|
<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|
</ul>
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
|
<i class="fa fa-search"></i>
|
|
</button>
|
|
</div>
|
|
|
|
<h1 class="menu-title">Rust Compiler Development Guide</h1>
|
|
|
|
<div class="right-buttons">
|
|
<a href="print.html" title="Print this book" aria-label="Print this book">
|
|
<i id="print-button" class="fa fa-print"></i>
|
|
</a>
|
|
<a href="https://github.com/rust-lang/rustc-dev-guide" title="Git repository" aria-label="Git repository">
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
|
</a>
|
|
<a href="https://github.com/rust-lang/rustc-dev-guide/edit/master/src/compiler-team.md" title="Suggest an edit" aria-label="Suggest an edit">
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|
</form>
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|
<ul id="searchresults">
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|
<script>
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|
});
|
|
</script>
|
|
|
|
<div id="content" class="content">
|
|
<main>
|
|
<h1 id="about-the-compiler-team"><a class="header" href="#about-the-compiler-team">About the compiler team</a></h1>
|
|
<p>rustc is maintained by the <a href="https://www.rust-lang.org/governance/teams/compiler">Rust compiler team</a>. The people who belong to
|
|
this team collectively work to track regressions and implement new features.
|
|
Members of the Rust compiler team are people who have made significant
|
|
contributions to rustc and its design.</p>
|
|
<h2 id="discussion"><a class="header" href="#discussion">Discussion</a></h2>
|
|
<p>Currently the compiler team chats in Zulip:</p>
|
|
<ul>
|
|
<li>Team chat occurs in the <a href="https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler"><code>t-compiler</code></a> stream on the Zulip instance</li>
|
|
<li>There are also a number of other associated Zulip streams,
|
|
such as <a href="https://rust-lang.zulipchat.com/#narrow/stream/182449-t-compiler.2Fhelp"><code>t-compiler/help</code></a>, where people can ask for help
|
|
with rustc development, or <a href="https://rust-lang.zulipchat.com/#narrow/stream/238009-t-compiler.2Fmeetings"><code>t-compiler/meetings</code></a>,
|
|
where the team holds their weekly triage and steering meetings.</li>
|
|
</ul>
|
|
<h2 id="reviewers"><a class="header" href="#reviewers">Reviewers</a></h2>
|
|
<p>If you're interested in figuring out who can answer questions about a
|
|
particular part of the compiler, or you'd just like to know who works on what,
|
|
check out <a href="https://github.com/rust-lang/rust/blob/master/triagebot.toml">triagebot.toml's assign section</a>.
|
|
It contains a listing of the various parts of the compiler and a list of people
|
|
who are reviewers of each part.</p>
|
|
<h2 id="rust-compiler-meeting"><a class="header" href="#rust-compiler-meeting">Rust compiler meeting</a></h2>
|
|
<p>The compiler team has a weekly meeting where we do triage and try to
|
|
generally stay on top of new bugs, regressions, and discuss important
|
|
things in general.
|
|
They are held on <a href="https://rust-lang.zulipchat.com/#narrow/stream/238009-t-compiler.2Fmeetings">Zulip</a>. It works roughly as follows:</p>
|
|
<ul>
|
|
<li><strong>Announcements, MCPs/FCPs, and WG-check-ins:</strong> We share some
|
|
announcements with the rest of the team about important things we want
|
|
everyone to be aware of. We also share the status of MCPs and FCPs and we
|
|
use the opportunity to have a couple of WGs giving us an update about
|
|
their work.</li>
|
|
<li><strong>Check for beta and stable nominations:</strong> These are nominations of things to
|
|
backport to beta and stable respectively.
|
|
We then look for new cases where the compiler broke previously working
|
|
code in the wild. Regressions are important issues to fix, so it's
|
|
likely that they are tagged as P-critical or P-high; the major
|
|
exception would be bug fixes (though even there we often <a href="./bug-fix-procedure.html">aim to give
|
|
warnings first</a>).</li>
|
|
<li><strong>Review P-critical and P-high bugs:</strong> P-critical and P-high bugs are
|
|
those that are sufficiently important for us to actively track
|
|
progress. P-critical and P-high bugs should ideally always have an
|
|
assignee.</li>
|
|
<li><strong>Check S-waiting-on-team and I-nominated issues:</strong> These are issues where feedback from
|
|
the team is desired.</li>
|
|
<li><strong>Look over the performance triage report:</strong> We check for PRs that made the
|
|
performance worse and try to decide if it's worth reverting the performance regression or if
|
|
the regression can be addressed in a future PR.</li>
|
|
</ul>
|
|
<p>The meeting currently takes place on Thursdays at 10am Boston time
|
|
(UTC-4 typically, but daylight savings time sometimes makes things
|
|
complicated).</p>
|
|
<h2 id="team-membership"><a class="header" href="#team-membership">Team membership</a></h2>
|
|
<p>Membership in the Rust team is typically offered when someone has been
|
|
making significant contributions to the compiler for some
|
|
time. Membership is both a recognition but also an obligation:
|
|
compiler team members are generally expected to help with upkeep as
|
|
well as doing reviews and other work.</p>
|
|
<p>If you are interested in becoming a compiler team member, the first
|
|
thing to do is to start fixing some bugs, or get involved in a working
|
|
group. One good way to find bugs is to look for
|
|
<a href="https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AE-easy">open issues tagged with E-easy</a>
|
|
or
|
|
<a href="https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AE-mentor">E-mentor</a>.</p>
|
|
<p>You can also dig through the graveyard of PRs that were
|
|
<a href="https://github.com/rust-lang/rust/pulls?q=is%3Apr+label%3AS-inactive">closed due to inactivity</a>,
|
|
some of them may contain work that is still useful - refer to the
|
|
associated issues, if any - and only needs some finishing touches
|
|
for which the original author didn't have time.</p>
|
|
<h3 id="r-rights"><a class="header" href="#r-rights">r+ rights</a></h3>
|
|
<p>Once you have made a number of individual PRs to rustc, we will often
|
|
offer r+ privileges. This means that you have the right to instruct
|
|
"bors" (the robot that manages which PRs get landed into rustc) to
|
|
merge a PR
|
|
(<a href="https://bors.rust-lang.org/">here are some instructions for how to talk to bors</a>).</p>
|
|
<p>The guidelines for reviewers are as follows:</p>
|
|
<ul>
|
|
<li>You are always welcome to review any PR, regardless of who it is
|
|
assigned to. However, do not r+ PRs unless:
|
|
<ul>
|
|
<li>You are confident in that part of the code.</li>
|
|
<li>You are confident that nobody else wants to review it first.
|
|
<ul>
|
|
<li>For example, sometimes people will express a desire to review a
|
|
PR before it lands, perhaps because it touches a particularly
|
|
sensitive part of the code.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>Always be polite when reviewing: you are a representative of the
|
|
Rust project, so it is expected that you will go above and beyond
|
|
when it comes to the <a href="https://www.rust-lang.org/policies/code-of-conduct">Code of Conduct</a>.</li>
|
|
</ul>
|
|
<h3 id="reviewer-rotation"><a class="header" href="#reviewer-rotation">Reviewer rotation</a></h3>
|
|
<p>Once you have r+ rights, you can also be added to the <a href="https://github.com/rust-lang/rust/blob/36285c5de8915ecc00d91ae0baa79a87ed5858d5/triagebot.toml#L528-L577">reviewer rotation</a>.
|
|
<a href="https://github.com/rust-lang/triagebot/">triagebot</a> is the bot that <a href="https://forge.rust-lang.org/triagebot/pr-assignment.html">automatically assigns</a> incoming PRs to reviewers.
|
|
If you are added, you will be randomly selected to review
|
|
PRs. If you find you are assigned a PR that you don't feel comfortable
|
|
reviewing, you can also leave a comment like <code>r? @so-and-so</code> to assign
|
|
to someone else — if you don't know who to request, just write <code>r? @nikomatsakis for reassignment</code> and @nikomatsakis will pick someone
|
|
for you.</p>
|
|
<p>Getting on the reviewer rotation is much appreciated as it lowers the
|
|
review burden for all of us! However, if you don't have time to give
|
|
people timely feedback on their PRs, it may be better that you don't
|
|
get on the list.</p>
|
|
<h3 id="full-team-membership"><a class="header" href="#full-team-membership">Full team membership</a></h3>
|
|
<p>Full team membership is typically extended once someone made many
|
|
contributions to the Rust compiler over time, ideally (but not
|
|
necessarily) to multiple areas. Sometimes this might be implementing a
|
|
new feature, but it is also important — perhaps more important! — to
|
|
have time and willingness to help out with general upkeep such as
|
|
bugfixes, tracking regressions, and other less glamorous work.</p>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="contributing.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="git.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
<div style="clear: both"></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|
<a rel="prev" href="contributing.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="git.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
window.playground_copyable = true;
|
|
</script>
|
|
|
|
|
|
<script src="elasticlunr.min.js"></script>
|
|
<script src="mark.min.js"></script>
|
|
<script src="searcher.js"></script>
|
|
|
|
<script src="clipboard.min.js"></script>
|
|
<script src="highlight.js"></script>
|
|
<script src="book.js"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
<script src="mermaid.min.js"></script>
|
|
<script src="mermaid-init.js"></script>
|
|
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|