|
| 1 | +# Contributing to a Touchlab Project |
| 2 | + |
| 3 | +## License |
| 4 | +By contributing you agree for your contribution to be licensed under the same license as the project which can be found in the LICENSE file. |
| 5 | +If no LICENSE file is present, all intellectual property rights for the project and contributions to the project are reserved by Touchlab. |
| 6 | + |
| 7 | +## Opening an issue |
| 8 | +Issues can be useful for reporting bugs and requesting features. |
| 9 | +If you simply have a question about the project or how to use it, please instead reach out in the [Kotlinlang touchlab-tools channel](https://kotlinlang.slack.com/archives/CTJB58X7X) |
| 10 | + |
| 11 | +### Reporting a Bug |
| 12 | +When reporting a problem with the project please provide as much detail as possible including: |
| 13 | +- The version of the project used as well as other relevant versions (eg: Kotlin, Android, iOS) |
| 14 | +- What behavior was expected |
| 15 | +- Steps to reproduce |
| 16 | + |
| 17 | +#### Sample Project |
| 18 | +Sharing a simple sample project which reproduces the issue is **immensely** helpful. |
| 19 | +Issues are often caused by project specific configurations and uses which are not practical for us to derive from a bug report. |
| 20 | +A reproducing project is often the first thing we ask for on difficult bugs and going through the process will help you make a more informed bug report. |
| 21 | + |
| 22 | +### Requesting an Enhancement |
| 23 | +We get a lot of great feedback from the community about how they use our projects and what can make them better. |
| 24 | +If you'd like to suggest an improvement that is not fixing a defect, please label it as an Enhancement. |
| 25 | +Share as much info as you can about your use case and how you would expect the enhancement might work. |
| 26 | +Please understand that even great ideas might not fit in with our vision for the project and, even if we don't implement them, we greatly appreciate your input |
| 27 | + |
| 28 | +## Submitting a PR |
| 29 | +We appreciate community members who are excited for our projects and willing to help improve them! |
| 30 | + |
| 31 | +### Before Submitting a PR |
| 32 | +If you are considering making a significant change, **please get in contact with us** before commiting a significant amount of time and effort. |
| 33 | +Even well thought out and constructed PRs sometimes do not fit into the current goals of the project and we would hate for anyone to feel their time is wasted. |
| 34 | +To discuss changes you can first [submit an issue](#opening-an-issue) documenting the bug or enhancement. Alternatively you can reach out in the [Kotlinlang touchlab-tools channel](https://kotlinlang.slack.com/archives/CTJB58X7X) |
| 35 | + |
| 36 | +### When Submitting a PR |
| 37 | +Please be sure to check that no tests are broken and relevant tests have been added. |
| 38 | +Include documentation updates for any changes to behavior or usage. |
| 39 | +Be as detailed as possible in your PR comments about what has changed and how to test it. |
| 40 | + |
| 41 | +## Other Ways To Help |
| 42 | +- Test and comment on other's contributions |
| 43 | + - Review PR's |
| 44 | + - Confirm issues and provide reproducers |
| 45 | +- Star the repository |
| 46 | +- Share the project with other developers |
0 commit comments