[apisix] branch master updated: docs: update contributing guide (#3089)

[we...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

wenming pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git


The following commit(s) were added to refs/heads/master by this push:
     new 0670eff  docs: update contributing guide (#3089)
0670eff is described below

commit 0670eff88fdadb4d4a1d306086993557f2e3e3bf
Author: 罗泽轩 <sp...@gmail.com>
AuthorDate: Mon Dec 21 20:13:21 2020 +0800

    docs: update contributing guide (#3089)
    
    Signed-off-by: spacewander <sp...@gmail.com>
---
 .github/semantic.yml | 13 +++++++++++++
 CONTRIBUTING.md      |  5 +++++
 2 files changed, 18 insertions(+)

diff --git a/.github/semantic.yml b/.github/semantic.yml
index 14940a2..5fe591e 100644
--- a/.github/semantic.yml
+++ b/.github/semantic.yml
@@ -1,2 +1,15 @@
 titleOnly: true
 allowRevertCommits: true
+types:
+  - feat
+  - fix
+  - docs
+  - style
+  - refactor
+  - perf
+  - test
+  - build
+  - ci
+  - chore
+  - revert
+  - change
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0863684..9df3a04 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -47,6 +47,7 @@ Once we've discussed your changes and you've got your code ready, make sure that
 * Includes tests for new functionality.
 * References the original issue in the description, e.g. "Resolves #123".
 * Has a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+* Ensure your pull request's title starts from one of the word in the `types` section of [semantic.yml](https://github.com/apache/apisix/blob/master/.github/semantic.yml).
 
 ## Contribution Guidelines for Documentation
 
@@ -113,6 +114,8 @@ Once we've discussed your changes and you've got your code ready, make sure that
             apisix/plugins/limit-count/*.lua > \
             /tmp/check.log 2>&1 || (cat /tmp/check.log && exit 1)
 ```
+      The `lj-releng` will be downloaded automatically by `make lint` if not exists.
+
 * test case style
     * Use tool to check your test case style statically by command, eg: `reindex t/admin/*.t`.
 ```shell
@@ -128,6 +131,8 @@ Once we've discussed your changes and you've got your code ready, make sure that
     reindex: t/plugin/zipkin.t:	skipped.
 ```
     * By the way, we can download "reindex" to another path and add this path to "PATH" environment.
+    * When the test file is too large, for example > 800 lines, you should split it to a new file.
+      Please take a look at `t/plugin/limit-conn.t` and `t/plugin/limit-conn2.t`.
 
 ## Do you have questions about the source code?