docs(contrib): add CONTRIBUTING.md

This commit is contained in:
z8674558 2020-12-04 15:23:10 +09:00 committed by tigercl
parent 6a7438ce6b
commit fd986bbbb2
1 changed files with 38 additions and 0 deletions

38
CONTRIBUTING.md Normal file
View File

@ -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>(<scope>): <subject>`
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)