doc: update links in README.md and CONTRIBUTING.md (#2609)

This commit is contained in:
Alice Ryhl 2020-07-22 00:31:26 +02:00 committed by GitHub
parent 04a2826084
commit 14723f9786
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 44 additions and 32 deletions

View File

@ -15,12 +15,14 @@ It should be considered a map to help you navigate the process.
The [dev channel][dev] is available for any concerns not covered in this guide, please join The [dev channel][dev] is available for any concerns not covered in this guide, please join
us! us!
[dev]: https://discord.gg/6yGkFeN [dev]: https://discord.gg/tokio
## Conduct ## Conduct
The Tokio project adheres to the [Rust Code of Conduct][coc]. This describes The Tokio project adheres to the [Rust Code of Conduct][coc]. This describes
the _minimum_ behavior expected from all contributors. Instances of violations of the Code of Conduct can be reported by contacting the project team at [moderation@tokio.rs](mailto:moderation@tokio.rs). the _minimum_ behavior expected from all contributors. Instances of violations of the
Code of Conduct can be reported by contacting the project team at
[moderation@tokio.rs](mailto:moderation@tokio.rs).
[coc]: https://github.com/rust-lang/rust/blob/master/CODE_OF_CONDUCT.md [coc]: https://github.com/rust-lang/rust/blob/master/CODE_OF_CONDUCT.md
@ -29,8 +31,8 @@ the _minimum_ behavior expected from all contributors. Instances of violations o
For any issue, there are fundamentally three ways an individual can contribute: For any issue, there are fundamentally three ways an individual can contribute:
1. By opening the issue for discussion: For instance, if you believe that you 1. By opening the issue for discussion: For instance, if you believe that you
have uncovered a bug in Tokio, creating a new issue in the tokio-rs/tokio have discovered a bug in Tokio, creating a new issue in [the tokio-rs/tokio
issue tracker is the way to report it. issue tracker][issue] is the way to report it.
2. By helping to triage the issue: This can be done by providing 2. By helping to triage the issue: This can be done by providing
supporting details (a test case that demonstrates a bug), providing supporting details (a test case that demonstrates a bug), providing
@ -42,21 +44,25 @@ For any issue, there are fundamentally three ways an individual can contribute:
often, by opening a Pull Request that changes some bit of something in often, by opening a Pull Request that changes some bit of something in
Tokio in a concrete and reviewable manner. Tokio in a concrete and reviewable manner.
[issue]: https://github.com/tokio-rs/tokio/issues
**Anybody can participate in any stage of contribution**. We urge you to **Anybody can participate in any stage of contribution**. We urge you to
participate in the discussion around bugs and participate in reviewing PRs. participate in the discussion around bugs and participate in reviewing PRs.
### Asking for General Help ### Asking for General Help
If you have reviewed existing documentation and still have questions or are If you have reviewed existing documentation and still have questions or are
having problems, you can open an issue asking for help. having problems, you can [open a discussion] asking for help.
In exchange for receiving help, we ask that you contribute back a documentation In exchange for receiving help, we ask that you contribute back a documentation
PR that helps others avoid the problems that you encountered. PR that helps others avoid the problems that you encountered.
[open a discussion]: https://github.com/tokio-rs/tokio/discussions/new
### Submitting a Bug Report ### Submitting a Bug Report
When opening a new issue in the Tokio issue tracker, users will be presented When opening a new issue in the Tokio issue tracker, you will be presented
with a [basic template][template] that should be filled in. If you believe that you have with a basic template that should be filled in. If you believe that you have
uncovered a bug, please fill out this form, following the template to the best uncovered a bug, please fill out this form, following the template to the best
of your ability. Do not worry if you cannot answer every detail, just fill in of your ability. Do not worry if you cannot answer every detail, just fill in
what you can. what you can.
@ -72,7 +78,6 @@ cases should be limited, as much as possible, to using only Tokio APIs.
See [How to create a Minimal, Complete, and Verifiable example][mcve]. See [How to create a Minimal, Complete, and Verifiable example][mcve].
[mcve]: https://stackoverflow.com/help/mcve [mcve]: https://stackoverflow.com/help/mcve
[template]: .github/PULL_REQUEST_TEMPLATE.md
### Triaging a Bug Report ### Triaging a Bug Report
@ -133,12 +138,11 @@ RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features
The `cargo fmt` command does not work on the Tokio codebase. You can use the The `cargo fmt` command does not work on the Tokio codebase. You can use the
command below instead: command below instead:
#### Bash
``` ```
# Mac or Linux
rustfmt --check --edition 2018 $(find . -name '*.rs' -print) rustfmt --check --edition 2018 $(find . -name '*.rs' -print)
```
#### Powershell # Powershell
```
Get-ChildItem . -Filter "*.rs" -Recurse | foreach { rustfmt --check --edition 2018 $_.FullName } Get-ChildItem . -Filter "*.rs" -Recurse | foreach { rustfmt --check --edition 2018 $_.FullName }
``` ```
The `--check` argument prints the things that need to be fixed. If you remove The `--check` argument prints the things that need to be fixed. If you remove

View File

@ -20,7 +20,7 @@ the Rust programming language. It is:
[crates-badge]: https://img.shields.io/crates/v/tokio.svg [crates-badge]: https://img.shields.io/crates/v/tokio.svg
[crates-url]: https://crates.io/crates/tokio [crates-url]: https://crates.io/crates/tokio
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg [mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[mit-url]: LICENSE [mit-url]: https://github.com/tokio-rs/tokio/blob/master/LICENSE
[azure-badge]: https://dev.azure.com/tokio-rs/Tokio/_apis/build/status/tokio-rs.tokio?branchName=master [azure-badge]: https://dev.azure.com/tokio-rs/Tokio/_apis/build/status/tokio-rs.tokio?branchName=master
[azure-url]: https://dev.azure.com/tokio-rs/Tokio/_build/latest?definitionId=1&branchName=master [azure-url]: https://dev.azure.com/tokio-rs/Tokio/_build/latest?definitionId=1&branchName=master
[discord-badge]: https://img.shields.io/discord/500028886025895936.svg?logo=discord&style=flat-square [discord-badge]: https://img.shields.io/discord/500028886025895936.svg?logo=discord&style=flat-square
@ -90,19 +90,23 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
} }
``` ```
More examples can be found [here](examples). More examples can be found [here][examples]. For a larger "real world" example, see the
[mini-redis] repository.
[examples]: https://github.com/tokio-rs/tokio/tree/master/examples
[mini-redis]: https://github.com/tokio-rs/mini-redis/
## Getting Help ## Getting Help
First, see if the answer to your question can be found in the [Guides] or the First, see if the answer to your question can be found in the [Guides] or the
[API documentation]. If the answer is not there, there is an active community in [API documentation]. If the answer is not there, there is an active community in
the [Tokio Discord server][chat]. We would be happy to try to answer your the [Tokio Discord server][chat]. We would be happy to try to answer your
question. Last, if that doesn't work, try opening an [issue] with the question. question. You can also ask your question on [the discussions page][discussions].
[Guides]: https://tokio.rs/docs/overview/ [Guides]: https://tokio.rs/docs/overview/
[API documentation]: https://docs.rs/tokio/latest/tokio [API documentation]: https://docs.rs/tokio/latest/tokio
[chat]: https://discord.gg/tokio [chat]: https://discord.gg/tokio
[issue]: https://github.com/tokio-rs/tokio/issues/new [discussions]: https://github.com/tokio-rs/tokio/discussions
## Contributing ## Contributing
@ -149,15 +153,15 @@ several other libraries, including:
## Supported Rust Versions ## Supported Rust Versions
Tokio is built against the latest stable, nightly, and beta Rust releases. The Tokio is built against the latest stable release. The minimum supported version is 1.39.
minimum version supported is the stable release from three months before the The current Tokio version is not guaranteed to build on Rust versions earlier than the
current stable release version. For example, if the latest stable Rust is 1.29, minimum supported version.
the minimum version supported is 1.26. The current Tokio version is not
guaranteed to build on Rust versions earlier than the minimum supported version.
## License ## License
This project is licensed under the [MIT license](LICENSE). This project is licensed under the [MIT license].
[MIT license]: https://github.com/tokio-rs/tokio/blob/master/LICENSE
### Contribution ### Contribution

View File

@ -20,7 +20,7 @@ the Rust programming language. It is:
[crates-badge]: https://img.shields.io/crates/v/tokio.svg [crates-badge]: https://img.shields.io/crates/v/tokio.svg
[crates-url]: https://crates.io/crates/tokio [crates-url]: https://crates.io/crates/tokio
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg [mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[mit-url]: LICENSE [mit-url]: https://github.com/tokio-rs/tokio/blob/master/LICENSE
[azure-badge]: https://dev.azure.com/tokio-rs/Tokio/_apis/build/status/tokio-rs.tokio?branchName=master [azure-badge]: https://dev.azure.com/tokio-rs/Tokio/_apis/build/status/tokio-rs.tokio?branchName=master
[azure-url]: https://dev.azure.com/tokio-rs/Tokio/_build/latest?definitionId=1&branchName=master [azure-url]: https://dev.azure.com/tokio-rs/Tokio/_build/latest?definitionId=1&branchName=master
[discord-badge]: https://img.shields.io/discord/500028886025895936.svg?logo=discord&style=flat-square [discord-badge]: https://img.shields.io/discord/500028886025895936.svg?logo=discord&style=flat-square
@ -90,19 +90,23 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
} }
``` ```
More examples can be found [here](examples). More examples can be found [here][examples]. For a larger "real world" example, see the
[mini-redis] repository.
[examples]: https://github.com/tokio-rs/tokio/tree/master/examples
[mini-redis]: https://github.com/tokio-rs/mini-redis/
## Getting Help ## Getting Help
First, see if the answer to your question can be found in the [Guides] or the First, see if the answer to your question can be found in the [Guides] or the
[API documentation]. If the answer is not there, there is an active community in [API documentation]. If the answer is not there, there is an active community in
the [Tokio Discord server][chat]. We would be happy to try to answer your the [Tokio Discord server][chat]. We would be happy to try to answer your
question. Last, if that doesn't work, try opening an [issue] with the question. question. You can also ask your question on [the discussions page][discussions].
[Guides]: https://tokio.rs/docs/overview/ [Guides]: https://tokio.rs/docs/overview/
[API documentation]: https://docs.rs/tokio/latest/tokio [API documentation]: https://docs.rs/tokio/latest/tokio
[chat]: https://discord.gg/tokio [chat]: https://discord.gg/tokio
[issue]: https://github.com/tokio-rs/tokio/issues/new [discussions]: https://github.com/tokio-rs/tokio/discussions
## Contributing ## Contributing
@ -149,15 +153,15 @@ several other libraries, including:
## Supported Rust Versions ## Supported Rust Versions
Tokio is built against the latest stable, nightly, and beta Rust releases. The Tokio is built against the latest stable release. The minimum supported version is 1.39.
minimum version supported is the stable release from three months before the The current Tokio version is not guaranteed to build on Rust versions earlier than the
current stable release version. For example, if the latest stable Rust is 1.29, minimum supported version.
the minimum version supported is 1.26. The current Tokio version is not
guaranteed to build on Rust versions earlier than the minimum supported version.
## License ## License
This project is licensed under the [MIT license](LICENSE). This project is licensed under the [MIT license].
[MIT license]: https://github.com/tokio-rs/tokio/blob/master/LICENSE
### Contribution ### Contribution