From a677f1442346e824921402a400b3d6a15eb55b33 Mon Sep 17 00:00:00 2001 From: 38elements Date: Mon, 15 May 2017 18:58:28 +0900 Subject: [PATCH 1/2] Add rule in CONTRIBUTING.md --- CONTRIBUTING.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 367956b6..924269df 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,10 +33,15 @@ So the pull request approval rules are pretty simple: 2. All pull requests must be reviewed and approved by at least one current collaborator on the project 3. All pull requests must pass flake8 checks -4. If you decide to remove/change anything from any common interface +4. All pull requests must be consistent with the existing codes. +5. If you decide to remove/change anything from any common interface a deprecation message should accompany it. -5. If you implement a new feature you should have at least one unit +6. If you implement a new feature you should have at least one unit test to accompany it. +7. An example must be one of the following. + Example of how to use Sanic + Example of how to use Sanic extensions + Example of how to use Sanic and asynchronous library ## Documentation From 6b7e19891b160bd3bd29cc3292cebf4cb306a3ac Mon Sep 17 00:00:00 2001 From: Eli Uriegas Date: Mon, 15 May 2017 10:54:47 -0700 Subject: [PATCH 2/2] Get rid of un-needed `s`, Fix some formatting. --- CONTRIBUTING.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 924269df..3e54af55 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,19 +29,19 @@ See it's that simple! ## Pull requests! So the pull request approval rules are pretty simple: -1. All pull requests must pass unit tests -2. All pull requests must be reviewed and approved by at least -one current collaborator on the project -3. All pull requests must pass flake8 checks -4. All pull requests must be consistent with the existing codes. +1. All pull requests must pass unit tests. +2. All pull requests must be reviewed and approved by at least +one current collaborator on the project. +3. All pull requests must pass flake8 checks. +4. All pull requests must be consistent with the existing code. 5. If you decide to remove/change anything from any common interface a deprecation message should accompany it. 6. If you implement a new feature you should have at least one unit test to accompany it. -7. An example must be one of the following. - Example of how to use Sanic - Example of how to use Sanic extensions - Example of how to use Sanic and asynchronous library +7. An example must be one of the following: + * Example of how to use Sanic + * Example of how to use Sanic extensions + * Example of how to use Sanic and asynchronous library ## Documentation