| 1 | # Guidance on how to contribute
|
| 2 |
|
| 3 | > All contributions to this project will be released under the CC0 public domain
|
| 4 | > dedication. By submitting a pull request or filing a bug, issue, or
|
| 5 | > feature request, you are agreeing to comply with this waiver of copyright interest.
|
| 6 | > Details can be found in our [TERMS](TERMS.md) and [LICENCE](LICENSE).
|
| 7 |
|
| 8 |
|
| 9 | There are two primary ways to help:
|
| 10 | - Using the issue tracker, and
|
| 11 | - Changing the code-base.
|
| 12 |
|
| 13 |
|
| 14 | ## Using the issue tracker
|
| 15 |
|
| 16 | Use the issue tracker to suggest feature requests, report bugs, and ask questions.
|
| 17 | This is also a great way to connect with the developers of the project as well
|
| 18 | as others who are interested in this solution.
|
| 19 |
|
| 20 | Use the issue tracker to find ways to contribute. Find a bug or a feature, mention in
|
| 21 | the issue that you will take on that effort, then follow the _Changing the code-base_
|
| 22 | guidance below.
|
| 23 |
|
| 24 |
|
| 25 | ## Changing the code-base
|
| 26 |
|
| 27 | Generally speaking, you should fork this repository, make changes in your
|
| 28 | own fork, and then submit a pull-request. All new code should have associated unit
|
| 29 | tests that validate implemented features and the presence or lack of defects.
|
| 30 | Additionally, the code should follow any stylistic and architectural guidelines
|
| 31 | prescribed by the project. In the absence of such guidelines, mimic the styles
|
| 32 | and patterns in the existing code-base.
|