Add a contributor guide #2097
Open
Add a contributor guide #2097
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rustbot
added
the
S-waiting-on-review
Member
|
30cb211 has wrong commit message |
tshepang
reviewed
Nov 25, 2025
ehuss
force-pushed
the
contributor-guide
branch
3 times, most recently
from
839f40c to
9b28ccc
Compare
This comment has been minimized.
This comment has been minimized.
This is the beginning of a new mdbook book that will house all of the guidelines for contributors. This is published via GitHub Pages.
This comment has been minimized.
This comment has been minimized.
ehuss
force-pushed
the
contributor-guide
branch
from
9b28ccc to
9951f64
Compare
Collaborator
|
This PR was rebased onto a different master commit. Here's a range-diff highlighting what actually changed. Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers. |
This is just some light editing. I expect that this chapter will have larger edits in the future, but I want to defer that till later.
This is just a stub, with the expectation that it will be expanded/rewritten later.
This is just a stub, with the expectation that it will be expanded/rewritten later.
This has been superseded by the contributor guide.
This introduction should probably receive deeper edits to make it fit into the guide better.
ehuss
force-pushed
the
contributor-guide
branch
from
9951f64 to
a7a2033
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a new contributor guide. It is built with mdbook with the intention that it is published on GitHub Pages. This replaces several of the loosely organized documents that we have accumulated over time. It also adds some new content aimed at contributors, such as an overview of the contribution process.
Several of the chapters are essentially stubs or basic starting points with the intention that they get reworked in the future. There's also still a lot of work left to resolve the Meta issues.
Note that I am also working on a separate but closely related initiative to add a scope chapter to the Reference itself, along with a rework of the introduction. This is intended to further clarify to contributors (and readers!) what is expected of the content.