From cc2c358d2585ea1149b701eb8c2c261fa5b35b91 Mon Sep 17 00:00:00 2001 From: Alice Ryhl Date: Wed, 29 Jul 2020 00:41:43 +0200 Subject: chore: document issue labels (#2708) --- CONTRIBUTING.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 70bc4559..18e38e80 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -425,6 +425,83 @@ _Adapted from the [Node.js contributing guide][node]_. [hiding-a-comment]: https://help.github.com/articles/managing-disruptive-comments/#hiding-a-comment [documentation test]: https://doc.rust-lang.org/rustdoc/documentation-tests.html +## Keeping track of issues and PRs + +The Tokio GitHub repository has a lot of issues and PRs, which is not easy to +keep track of. This section explains the meaning of various labels, as well as +our [GitHub project][project]. The section is primarily targeted at maintainers. + +**Area.** The area label describes the crates relevant to this issue or PR. + + - **A-tokio** This issue concerns the main Tokio crate. + - **A-tokio-util** This issue concerns the `tokio-util` crate. + - **A-tokio-tls** This issue concerns the `tokio-tls` crate. Only used for + older issues, as the crate has been moved to another repository. + - **A-tokio-test** The issue concerns the `tokio-test` crate. + - **A-tokio-macros** This issue concerns the `tokio-macros` crate. Should only + be used for the procedural macros, and not `join!` or `select!`. + - **A-ci** This issue concerns our GitHub Actions setup. + +**Category.** The category label describes the category. + + - **C-bug** This is a bug-report. Bug-fix PRs use `C-enhancement` instead. + - **C-enhancement** This is a PR that adds a new features. + - **C-maintenance** This is an issue or PR about stuff such as documentation, + GitHub Actions or code quality. + - **C-feature-request** This is a feature request. Implementations of feature + requests use `C-enhancement` instead. + - **C-feature-accepted** If you submit a PR for this feature request, we wont + close it with the reason "we don't want this". Issues with this label should + also have the `C-feature-request` label. + - **C-musing** Stuff like tracking issues or roadmaps. "musings about a better + world" + - **C-proposal** A proposal of some kind, and a request for comments. + - **C-question** A user question. Large overlap with GitHub discussions. + - **C-request** A non-feature request, e.g. "please add deprecation notices to + `-alpha.*` versions of crates" + +**Call for participation.** I don't know why it's called `E-`. Many issues are +missing a difficulty rating, and you should feel free to add one. + + - **E-help-wanted** Stuff where we want help. Often seen together with `C-bug` + or `C-feature-accepted`. + - **E-easy** This is easy, ranging from quick documentation fixes to stuff you + can do after reading the tutorial on our website. + - **E-medium** This is not `E-easy` or `E-hard`. + - **E-hard** This either involves very tricky code, is something we don't know + how to solve, or is difficult for some other reason. + - **E-needs-mvce** This bug is missing a minimal complete and verifiable + example. + +**Module.** A more fine groaned categorization than area. + + - **M-blocking** Things relevant to `spawn_blocking`, `block_in_place`. + - **M-codec** The `tokio_util::codec` module. + - **M-compat** The `tokio_util::compat` module. + - **M-coop** Things relevant to coop. + - **M-fs** The `tokio::fs` module. + - **M-io** The `tokio::io` module. + - **M-macros** Issues about any kind of macro. + - **M-net** The `tokio::net` module. + - **M-process** The `tokio::process` module. + - **M-runtime** The `tokio::runtime` module. + - **M-signal** The `tokio::signal` module. + - **M-stream** The `tokio::stream` module. + - **M-sync** The `tokio::sync` module. + - **M-task** The `tokio::task` module. + - **M-time** The `tokio::time` module. + - **M-tracing** Tracing support in Tokio. + +**Topic.** Some extra information. + + - **T-docs** This is about documentation. + - **T-performance** This is about performance. + - **T-v0.1.x** This is about old Tokio. + +Any label not listed here is not in active use. + +[project]: https://github.com/orgs/tokio-rs/projects/1 + ## Releasing Since the Tokio project consists of a number of crates, many of which depend on -- cgit v1.2.3