Skip to content
Permalink
Browse files
docs: update contributing guide (#3089)
Signed-off-by: spacewander <spacewanderlzx@gmail.com>
  • Loading branch information
spacewander committed Dec 21, 2020
1 parent 7c158b7 commit 0670eff88fdadb4d4a1d306086993557f2e3e3bf
Showing 2 changed files with 18 additions and 0 deletions.
@@ -1,2 +1,15 @@
titleOnly: true
allowRevertCommits: true
types:
- feat
- fix
- docs
- style
- refactor
- perf
- test
- build
- ci
- chore
- revert
- change
@@ -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?

0 comments on commit 0670eff

Please sign in to comment.