gendry/CONTRIBUTING.md
caibirdme c0ddcdf42b init
2017-12-01 17:24:37 +08:00

22 lines
853 B
Markdown

## Contribution Guideline
Thanks for considering to contribute this project. All issues and pull requests are highly appreciated.
### Pull Requests
Before sending pull request to this project, please read and follow guidelines below.
* Coding style: [goreporter](https://github.com/360EntSecGroup-Skylar/goreporter) is suggested to help check your code, or your code should at least pass the examination by:
* [govet](https://golang.org/cmd/vet/#hdr-Shadowed_variables)
* [golint](https://github.com/golang/lint)
* Commit message: Use English and be aware of your spelling.
* Test: Make sure to test your code.
NOTE: We assume all your contribution can be licensed under the [Apache License 2.0](./LICENSE).
### Test Cases
PR with adding test cases is always welcome! Feel free to do that
### Issues
We love clearly described issues. :)