|
| 1 | +# Contributing Guidelines |
| 2 | + |
| 3 | +For anyone looking to get involved to this project, we are glad to hear from you. Here are a few types of contributions |
| 4 | +that we would be interested in hearing about. |
| 5 | + |
| 6 | +* Bug fixes |
| 7 | + - If you find a bug, please first report it using Github Issues. |
| 8 | + - Issues that have already been identified as a bug will be labelled `bug`. |
| 9 | + - If you'd like to submit a fix for a bug, send a Pull Request from your own fork and mention the Issue number. |
| 10 | + + Include a test that isolates the bug and verifies that it was fixed. |
| 11 | +* New Features |
| 12 | + - If you'd like to accomplish something in the library that it doesn't already do, describe the problem in a new |
| 13 | + Github Issue. |
| 14 | + - Issues that have been identified as a feature request will be labelled `enhancement`. |
| 15 | + - If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending |
| 16 | + too much time writing the code. In some cases, `enhancement`s may not align well with the project objectives at |
| 17 | + the time. |
| 18 | +* Tests, Documentation, Miscellaneous |
| 19 | + - If you think the test coverage could be improved, the documentation could be clearer, you've got an alternative |
| 20 | + implementation of something that may have more advantages, or any other change we would still be glad hear about |
| 21 | + it. |
| 22 | + - If its a trivial change, go ahead and send a Pull Request with the changes you have in mind |
| 23 | + - If not, open a Github Issue to discuss the idea first. |
| 24 | + |
| 25 | +## Requirements |
| 26 | + |
| 27 | +For a contribution to be accepted: |
| 28 | + |
| 29 | +* The test suite must be complete and pass |
| 30 | +* Code must follow existing styling conventions |
| 31 | +* Commit messages must be descriptive. Related issues should be mentioned by number. |
| 32 | + |
| 33 | +If the contribution doesn't meet these criteria, a maintainer will discuss it with you on the Issue. You can still |
| 34 | +continue to add more commits to the branch you have sent the Pull Request from. |
| 35 | + |
| 36 | +## How To |
| 37 | + |
| 38 | +1. Fork this repository on GitHub. |
| 39 | +1. Clone/fetch your fork to your local development machine. |
| 40 | +1. Create a new branch (e.g. `issue-12`, `feat.add_foo`, etc) and check it out. |
| 41 | +1. Make your changes and commit them. (Did the tests pass?) |
| 42 | +1. Push your new branch to your fork. (e.g. `git push myname issue-12`) |
| 43 | +1. Open a Pull Request from your new branch to the original fork's `master` branch. |
0 commit comments