From fd986bbbb2e9ad0676bd425c5a6db681778b2366 Mon Sep 17 00:00:00 2001 From: z8674558 Date: Fri, 4 Dec 2020 15:23:10 +0900 Subject: [PATCH] docs(contrib): add CONTRIBUTING.md --- CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..f2c61087b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# Contributing + +You are welcome to submit any bugs, issues and feature requests on this repository. + +## Pull Request Process + +1. Update the README.md with details of changes to the interface. + +2. Ensure that each of the commit messages are in the following style: + + Format: `(): ` + + Type: + + - `feat`: (new feature for the user, not a new feature for build script) + - `fix`: (bug fix for the user, not a fix to a build script) + - `docs`: (changes to the documentation) + - `style`: (formatting, missing semi colons, etc; no production code change) + - `refactor`: (refactoring production code, eg. renaming a variable) + - `test`: (adding missing tests, refactoring tests; no production code change) + - `chore`: (updating grunt tasks etc; no production code change) + - `perf`: (performance improvements) + + **Example** + + ``` + feat(build): deterministic compile option + ^--^ ^---^ ^--------------------------^ + | | | + | | +-> Summary in present tense. + | | + | | + | +-------> Scope of the change. + | + +-------> Type: chore, docs, feat, fix, perf, refactor, style, or test. + ``` + + [Reference](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716)