| 1 | # Contribution Guide
|
| 2 |
|
| 3 | Please follow this guide when
|
| 4 | creating issues or pull requests.
|
| 5 |
|
| 6 |
|
| 7 | ## Code of Conduct
|
| 8 |
|
| 9 | The [Code of Conduct](CODE_OF_CONDUCT.md)
|
| 10 | will be enforced in all project spaces.
|
| 11 | Please read it
|
| 12 | so that you know what kind of behavior
|
| 13 | is expected here.
|
| 14 |
|
| 15 |
|
| 16 | ## Reporting a Bug
|
| 17 |
|
| 18 | Before reporting a bug,
|
| 19 | make sure you are using the latest version
|
| 20 | of this project.
|
| 21 |
|
| 22 | When reporting a bug,
|
| 23 | please provide a minimal test case.
|
| 24 | This can be a gist,
|
| 25 | inline in the description,
|
| 26 | or in the form of a pull request
|
| 27 | that includes a failing test.
|
| 28 |
|
| 29 | If you are contributing a bug fix,
|
| 30 | make sure it has a passing test
|
| 31 | in your pull request.
|
| 32 |
|
| 33 |
|
| 34 | ## Code Style
|
| 35 |
|
| 36 | Please follow the code style
|
| 37 | found in this project.
|
| 38 | You can use [editorconfig](http://editorconfig.org)
|
| 39 | to help with this.
|