Create CONTRIBUTING.md

This commit is contained in:
Andy Pan 2019-08-27 23:10:55 +08:00 committed by GitHub
parent d5eded45bf
commit a462acf87d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 0 deletions

14
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,14 @@
# Contributing
## With issues:
- Use the search tool before opening a new issue.
- Please provide source code and commit sha if you found a bug.
- Review existing issues and provide feedback or react to them.
## With pull requests:
- Open your pull request against `master`.
- Open one pull request for only one feature/proposal, if you have several those, please put them into different PRs, whereas you are allowed to open one pull request with several bug-fixs.
- Your pull request should have no more than two commits, if not, you should squash them.
- It should pass all tests in the available continuous integrations systems such as TravisCI.
- You should add/modify tests to cover your proposed code changes.
- If your pull request contains a new feature, please document it on the README.