Overview - Rust Forge

<!DOCTYPE HTML> <html lang="en" class="light" dir="ltr"> <head>  <meta charset="UTF-8"> <title>Overview - Rust Forge</title>  <meta name="description" content="Supplemental documentation for contributing to The Rust Programming Language"> <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">  <link rel="stylesheet" href="FontAwesome/css/font-awesome.css"> <link rel="stylesheet" href="fonts/fonts.css">  <link rel="stylesheet" href="highlight.css"> <link rel="stylesheet" href="tomorrow-night.css"> <link rel="stylesheet" href="ayu-highlight.css">  </head> <body class="sidebar-visible no-js"> <div id="body-container">  <script> var path_to_root = ""; var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light"; </script>  <script> try { var theme = localStorage.getItem('mdbook-theme'); var 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>  <script> var theme; try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { } if (theme === null || theme === undefined) { theme = default_theme; } var html = document.querySelector('html'); html.classList.remove('light') html.classList.add(theme); var body = document.querySelector('body'); body.classList.remove('no-js') body.classList.add('js'); </script> <input type="checkbox" id="sidebar-toggle-anchor" class="hidden">  <script> var body = document.querySelector('body'); var sidebar = null; var 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'; body.classList.remove('sidebar-visible'); body.classList.add("sidebar-" + sidebar); </script> <nav id="sidebar" class="sidebar" aria-label="Table of contents"> <div class="sidebar-scrollbox"> <ol class="chapter"><li class="chapter-item expanded affix "><a href="index.html" class="active">Overview</a></li><li class="chapter-item expanded "><a href="platforms/index.html">Platforms</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="platforms/twitter.html">Twitter</a></li><li class="chapter-item expanded "><a href="platforms/discord.html">Discord</a></li><li class="chapter-item expanded "><a href="platforms/email.html">Email</a></li><li class="chapter-item expanded "><a href="platforms/github.html">GitHub</a></li><li class="chapter-item expanded "><a href="platforms/zulip.html">Zulip</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="platforms/zulip/moderation.html">Moderation</a></li></ol></li><li class="chapter-item expanded "><a href="platforms/blogs.html">Blogs</a></li><li class="chapter-item expanded "><a href="platforms/calendars.html">Calendars</a></li></ol></li><li class="chapter-item expanded "><a href="triagebot/index.html">Triagebot</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="triagebot/agenda.html">Agenda Generator</a></li><li class="chapter-item expanded "><a href="triagebot/issue-assignment.html">Issue Assignment</a></li><li class="chapter-item expanded "><a href="triagebot/pr-assignment.html">PR Assignment</a></li><li class="chapter-item expanded "><a href="triagebot/pr-assignment-tracking.html">Tracking PR assignment</a></li><li class="chapter-item expanded "><a href="triagebot/autolabels.html">Autolabels</a></li><li class="chapter-item expanded "><a href="triagebot/close.html">Close</a></li><li class="chapter-item expanded "><a href="triagebot/doc-updates.html">Documentation Updates</a></li><li class="chapter-item expanded "><a href="triagebot/github-releases.html">GitHub Releases</a></li><li class="chapter-item expanded "><a href="triagebot/glacier.html">Glacier</a></li><li class="chapter-item expanded "><a href="triagebot/transfer.html">Issue Transfer</a></li><li class="chapter-item expanded "><a href="triagebot/labeling.html">Labeling</a></li><li class="chapter-item expanded "><a href="triagebot/major-changes.html">Major Changes</a></li><li class="chapter-item expanded "><a href="triagebot/mentions.html">Mentions</a></li><li class="chapter-item expanded "><a href="triagebot/merge-conflicts.html">Merge Conflicts</a></li><li class="chapter-item expanded "><a href="triagebot/no-merge.html">No Merge Policy</a></li><li class="chapter-item expanded "><a href="triagebot/nominate.html">Nominate</a></li><li class="chapter-item expanded "><a href="triagebot/note.html">Note</a></li><li class="chapter-item expanded "><a href="triagebot/notifications.html">Notifications</a></li><li class="chapter-item expanded "><a href="triagebot/pinging.html">Pinging</a></li><li class="chapter-item expanded "><a href="triagebot/rendered-link.html">Rendered link</a></li><li class="chapter-item expanded "><a href="triagebot/requesting-prioritization.html">Requesting Prioritization</a></li><li class="chapter-item expanded "><a href="triagebot/review-submitted.html">Review Changes Requested</a></li><li class="chapter-item expanded "><a href="triagebot/review-requested.html">Review Requested</a></li><li class="chapter-item expanded "><a href="triagebot/rustc-commit-list.html">Rustc Commit Tracking</a></li><li class="chapter-item expanded "><a href="triagebot/shortcuts.html">Shortcuts</a></li><li class="chapter-item expanded "><a href="triagebot/triage-dashboard.html">Triagebot Dashboard</a></li><li class="chapter-item expanded "><a href="triagebot/zulip-meeting.html">Zulip Meeting Management</a></li><li class="chapter-item expanded "><a href="triagebot/zulip-notifications.html">Zulip Notifications</a></li><li class="chapter-item expanded "><a href="triagebot/bot-pull-requests.html">GitHub Actions created PR open/closer</a></li></ol></li><li class="chapter-item expanded "><a href="community/index.html">Community</a></li><li class="chapter-item expanded "><a href="compiler/index.html">Compiler</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="compiler/calendar.html">Calendar</a></li><li class="chapter-item expanded "><a href="compiler/cross-team-collaboration.html">Cross-team Collaboration</a></li><li class="chapter-item expanded "><a href="compiler/meetings.html">Meetings</a></li><li class="chapter-item expanded "><a href="compiler/membership.html">Membership</a></li><li class="chapter-item expanded "><a href="compiler/notification-groups.html">Notification groups</a></li><li class="chapter-item expanded "><a href="compiler/resources.html">Resources</a></li><li class="chapter-item expanded "><a href="compiler/reviews.html">Review Policy</a></li><li class="chapter-item expanded "><a href="compiler/proposals-and-stabilization.html">Proposals, Approval and Stabilization</a></li><li class="chapter-item expanded "><a href="compiler/third-party-out-of-tree.html">Third-party and Out-of-tree Crates Policy</a></li><li class="chapter-item expanded "><a href="compiler/prioritization.html">Triage and Prioritization</a></li><li class="chapter-item expanded "><a href="compiler/working-areas.html">Working Areas</a></li><li class="chapter-item expanded "><a href="compiler/operations.html">Operations</a></li></ol></li><li class="chapter-item expanded "><a href="crates-io/index.html">crates.io</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="crates-io/crate-removal.html">Crate removal</a></li><li class="chapter-item expanded "><a href="crates-io/db-maintenance.html">Database maintenance</a></li></ol></li><li class="chapter-item expanded "><a href="docs-rs/index.html">docs.rs</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="docs-rs/add-dependencies.html">Adding dependencies to the build environment</a></li><li class="chapter-item expanded "><a href="docs-rs/self-hosting.html">Self-hosting a docs.rs instance</a></li><li class="chapter-item expanded "><a href="docs-rs/maintenance.html">Maintenance procedures</a></li></ol></li><li class="chapter-item expanded "><a href="governance/index.html">Governance</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="governance/council.html">Leadership Council</a></li><li class="chapter-item expanded "><a href="governance/moderation.html">Moderation</a></li></ol></li><li class="chapter-item expanded "><a href="policies/index.html">Policies</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="policies/crate-ownership.html">Crate ownership policy</a></li></ol></li><li class="chapter-item expanded "><a href="infra/index.html">Infrastructure</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="infra/other-installation-methods.html">Other Installation Methods</a></li><li class="chapter-item expanded "><a href="infra/archive-stable-version-installers.html">Archive of Rust Stable Standalone Installers</a></li><li class="chapter-item expanded "><a href="infra/channel-layout.html">Release Channel Layout</a></li><li class="chapter-item expanded "><a href="infra/service-infrastructure.html">Service Infrastructure</a></li><li class="chapter-item expanded "><a href="infra/team-maintenance.html">Team Maintenance</a></li><li class="chapter-item expanded "><a href="infra/toolstate.html">The Toolstate System</a></li><li class="chapter-item expanded "><a href="infra/policies/index.html">Policies</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="infra/policies/broken-nightlies.html">Broken nightlies</a></li></ol></li><li class="chapter-item expanded "><a href="infra/guidelines/index.html">Guidelines</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="infra/guidelines/static-websites.html">Static websites</a></li></ol></li><li class="chapter-item expanded "><a href="infra/docs/index.html">Documentation</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="infra/docs/aws-access.html">AWS access for team members</a></li><li class="chapter-item expanded "><a href="infra/docs/aws-access-management.html">AWS access management</a></li><li class="chapter-item expanded "><a href="infra/docs/aws-regions.html">AWS regions</a></li><li class="chapter-item expanded "><a href="infra/docs/bastion.html">Bastion server</a></li><li class="chapter-item expanded "><a href="infra/docs/bors.html">Bors</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="infra/docs/bors/queue-resync.html">Fixing bors queue</a></li></ol></li><li class="chapter-item expanded "><a href="infra/docs/cdn.html">CDN</a></li><li class="chapter-item expanded "><a href="infra/docs/crater-agents.html">Crater agents</a></li><li class="chapter-item expanded "><a href="infra/docs/dev-desktop.html">Dev Desktops</a></li><li class="chapter-item expanded "><a href="infra/docs/dev-desktop-github-app.html">GitHub App for dev-desktops</a></li><li class="chapter-item expanded "><a href="infra/docs/discord-mods-bot.html">Discord moderation bot</a></li><li class="chapter-item expanded "><a href="infra/docs/dns.html">Domain names and DNS</a></li><li class="chapter-item expanded "><a href="infra/docs/docs-rs.html">docs.rs</a></li><li class="chapter-item expanded "><a href="infra/docs/ecs-services.html">ECS services management</a></li><li class="chapter-item expanded "><a href="infra/docs/monitoring.html">Monitoring</a></li><li class="chapter-item expanded "><a href="infra/docs/rust-bots.html">rust-bots server</a></li><li class="chapter-item expanded "><a href="infra/docs/rustc-ci.html">rust-lang/rust CI</a></li><li class="chapter-item expanded "><a href="infra/docs/sentry.html">Sentry</a></li></ol></li></ol></li><li class="chapter-item expanded "><a href="lang/index.html">Language</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="lang/rfc-merge-procedure.html">RFC Merge Procedure</a></li><li class="chapter-item expanded "><a href="lang/triage-meeting-procedure.html">Triage Meeting Procedure</a></li><li class="chapter-item expanded "><a href="lang/stabilization-procedure.html">Stabilization procedure</a></li></ol></li><li class="chapter-item expanded "><a href="libs/index.html">Libs</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="libs/maintaining-std.html">Maintaining the standard library</a></li></ol></li><li class="chapter-item expanded "><a href="release/index.html">Release</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="release/backporting.html">Backporting</a></li><li class="chapter-item expanded "><a href="release/release-notes.html">Preparing Release Notes</a></li><li class="chapter-item expanded "><a href="release/process.html">Release Process</a></li><li class="chapter-item expanded "><a href="release/rollups.html">Rollup Procedure</a></li><li class="chapter-item expanded "><a href="release/triage-procedure.html">Triage Procedure</a></li><li class="chapter-item expanded "><a href="release/issue-triaging.html">Issue Triaging</a></li><li class="chapter-item expanded "><a href="release/crater.html">Triaging Crater Runs</a></li></ol></li><li class="chapter-item expanded "><a href="editions/edition-releases.html">Edition Releases</a></li><li class="chapter-item expanded "><a href="archive/index.html">Archive</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="archive/fott.html">Friends of the Tree</a></li><li class="chapter-item expanded "><a href="archive/release-history.html">Release History</a></li></ol></li></ol> </div> <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div> </nav>  <script> var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox'); sidebarScrollbox.addEventListener('click', function(e) { if (e.target.tagName === 'A') { sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop); } }, { passive: true }); var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll'); sessionStorage.removeItem('sidebar-scroll'); if (sidebarScrollTop) { // preserve sidebar scroll position when navigating via links within sidebar sidebarScrollbox.scrollTop = sidebarScrollTop; } else { // scroll sidebar to current active section when navigating via "next/previous chapter" buttons var activeSection = document.querySelector('#sidebar .active'); if (activeSection) { activeSection.scrollIntoView({ block: 'center' }); } } </script> <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="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 Forge</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/rust-forge" 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/rust-forge/edit/master/src/README.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>  <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="rust-forge"><a class="header" href="#rust-forge">Rust Forge</a></h1> <p>Welcome to the Rust Forge! Rust Forge serves as a repository of supplementary documentation useful for members of <a href="https://rust-lang.org">The Rust Programming Language</a>. If you find any mistakes, typos, or want to add to the Rust Forge, feel free to file an issue or PR on the <a href="https://github.com/rust-lang/rust-forge">Rust Forge GitHub</a>.</p> <h3 id="help-wanted"><a class="header" href="#help-wanted">Help Wanted</a></h3> <p>Want to contribute to Rust, but don鈥檛 know where to start? Here鈥檚 a list of <code>rust-lang</code> projects that have marked issues that need help and issues that are good first issues.</p> <div class="table-wrapper"><table><thead><tr><th>Repository</th><th>Description</th></tr></thead><tbody> <tr><td><a href="https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AE-help-wanted+no%3Aassignee">rust</a></td><td>The Rust Language & Compiler</td></tr> <tr><td><a href="https://github.com/rust-lang/cargo/issues?q=is%3Aopen+is%3Aissue+label%3AS-accepted+no%3Aassignee">cargo</a></td><td>The Rust package manager</td></tr> <tr><td><a href="https://github.com/rust-lang/crates.io/issues?q=is%3Aopen+is%3Aissue+label%3AE-help-wanted+no%3Aassignee">crates.io</a></td><td>Source code for <a href="https://crates.io">crates.io</a></td></tr> <tr><td><a href="https://github.com/rust-lang/www.rust-lang.org/issues?q=is%3Aopen+label%3A%22good+first+issue%22+no%3Aassignee">www.rust-lang.org</a></td><td>The Rust website</td></tr> </tbody></table> </div> <h3 id="current-release-versions"><a class="header" href="#current-release-versions">Current Release Versions</a></h3>  <div class="table-wrapper"><table><thead><tr><th>Channel</th><th>Version</th><th>Will be stable on</th><th>Will branch from master on</th></tr></thead><tbody> <tr><td>Stable</td><td><span id="stable-version"></span></td><td><span id="stable-release-date"></span></td><td><span id="stable-branch-date"></span></td></tr> <tr><td>Beta</td><td><span id="beta-version"></span></td><td><span id="beta-release-date"></span></td><td><span id="beta-branch-date"></span></td></tr> <tr><td>Nightly</td><td><span id="nightly-version"></span></td><td><span id="nightly-release-date"></span></td><td><span id="nightly-branch-date"></span></td></tr> <tr><td>Nightly +1</td><td><span id="next-version"></span></td><td><span id="next-release-date"></span></td><td><span id="next-branch-date"></span></td></tr> </tbody></table> </div> <p>See the <a href="./release/process.html">release process</a> documentation for details on what happens in the days leading up to a release.</p> <h3 id="no-tools-breakage-week"><a class="header" href="#no-tools-breakage-week">No Tools Breakage Week</a></h3> <p>To ensure the beta release includes all the tools, no <a href="./infra/toolstate.html">tool breakages</a> are allowed in the week before the beta cutoff (except for nightly-only tools).</p> <div class="table-wrapper"><table><thead><tr><th>Beta Cut</th><th>No Breakage Week</th></tr></thead><tbody> <tr><td><span id="nightly-cycle"></span></td><td><span id="nightly-timespan"></span></td></tr> <tr><td><span id="next-cycle"></span></td><td><span id="next-timespan"></span></td></tr> </tbody></table> </div> <h3 id="external-links"><a class="header" href="#external-links">External Links</a></h3> <ul> <li><a href="https://rustc-dev-guide.rust-lang.org/appendix/bibliography.html">Bibliography</a> of research papers and other projects that influenced Rust.</li> <li><a href="https://pontoon.rust-lang.org/">Rust Pontoon</a> is a translation management system used to localize the Rust website.</li> </ul> </main> <nav class="nav-wrapper" aria-label="Page navigation">  <a rel="next prefetch" href="platforms/index.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="next prefetch" href="platforms/index.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>  <script src="js/moment.min.js"></script> <script src="js/index.js"></script> </div> </body> </html>

CINXE.COM

Overview - Rust Forge