docs: break up CONTRIBUTING.md
#7762
Merged
+659
−700
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
mattiapitossi
changed the title
CONTRIBUTING.mdCONTRIBUTING.md
mox692
reviewed
Dec 6, 2025
Comment on lines
30
to
37
| ## LTS guarantees | ||
|
|
||
| Tokio ≥1.0.0 comes with LTS guarantees: | ||
|
|
||
| * A minimum of 5 years of maintenance. | ||
| * A minimum of 3 years before a hypothetical 2.0 release. | ||
| * A minimum of 5 years of maintenance. | ||
| * A minimum of 3 years before a hypothetical 2.0 release. | ||
|
|
||
| The goal of these guarantees is to provide stability to the ecosystem. |
Member
There was a problem hiding this comment.
This part is probably outdated? We currently have an LTS release that receives backports for at least one year.
Contributor
Author
There was a problem hiding this comment.
Thanks, updated!
docs/contributing/releasing.md
Outdated
| @@ -0,0 +1,58 @@ | |||
| ## Releasing | |||
Member
There was a problem hiding this comment.
I'm wondering if we can drop this file entirely, as contributors normally wouldn't publish tokio to crates.io
Contributor
Author
There was a problem hiding this comment.
I don't see any reason to keep this file as well for contributors, I've removed it
ADD-SP
reviewed
Dec 7, 2025
ADD-SP
added
the
S-waiting-on-author
Contributor
Author
Thanks! updated |
ADD-SP
removed
the
S-waiting-on-author
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.
Motivation
Closes #2707.
The
CONTRIBUTING.mddoc is a bit outdated and overwhelming. This PR aims at breaking the docs in different files, provides a quick start guide, and table of content.There might be some improvements that can be done but I think it's better to keep this PR for breaking up and removing outdated docs, and eventually open another PR for other improvements.
Solution
CONTRIBUTING.md