aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorVsevolod Tolstopyatov <qwwdfsad@gmail.com>2021-03-25 16:43:25 +0300
committerGitHub <noreply@github.com>2021-03-25 16:43:25 +0300
commit2021b5aee1ad93f48bd6e54915ad4e09f11300c7 (patch)
tree2f7c05b52d084aa20021ca73b10fb3caee33b352 /CONTRIBUTING.md
parenta67fd8e222628916e678d34915c14c6bab161808 (diff)
downloadkotlinx.coroutines-2021b5aee1ad93f48bd6e54915ad4e09f11300c7.tar.gz
Update contribution guide (#2608)
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7737062f..4628eade 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -52,6 +52,10 @@ so do familiarize yourself with the following guidelines.
* Follow the style of writing tests that is used in this project:
name test functions as `testXxx`. Don't use backticks in test names.
* If you introduce any new public APIs:
+ * Comment on the existing issue if you want to work on it or create one beforehand.
+ Ensure that the issue not only describes a problem, but also describes a solution that had received a positive feedback. Propose a solution if there isn't any.
+ PRs with new API, but without a corresponding issue with a positive feedback about the proposed implementation are unlikely to
+ be approved or reviewed.
* All new APIs must come with documentation and tests.
* All new APIs are initially released with `@ExperimentalCoroutineApi` annotation and are graduated later.
* [Update the public API dumps](#updating-the-public-api-dump) and commit the resulting changes as well.
@@ -59,8 +63,6 @@ so do familiarize yourself with the following guidelines.
* If you plan large API additions, then please start by submitting an issue with the proposed API design
to gather community feedback.
* [Contact the maintainers](#contacting-maintainers) to coordinate any big piece of work in advance.
-* Comment on the existing issue if you want to work on it. Ensure that the issue not only describes a problem,
- but also describes a solution that had received a positive feedback. Propose a solution if there isn't any.
* Steps for contributing new integration modules are explained [here](integration/README.md#Contributing).
## Building