Inkycal/.github/CONTRIBUTING.md

32 lines
1.8 KiB
Markdown
Raw Normal View History

2022-08-27 13:04:53 +02:00
# Inkycal Contribution Policy
2018-10-02 16:53:48 +02:00
2022-08-27 13:04:53 +02:00
Thanks for willing to contribute to Inkycal
We welcome all sort of contributions, for example:
* giving support via the Discord server
* submitting hotfixes for existing bugs
* giving ideas for new features
* financial contributions (while Inkycal is still dependent on them. These go towards new hardware, displays and a bit of coffee)
2018-10-02 16:53:48 +02:00
2022-08-27 13:04:53 +02:00
# Third party modules
So you had a great idea for an inkycal-module? Awesome! In fact, there is already a repo sepcfifically created for that purpose: [inkycal-modules-template](https://github.com/aceisace/inkycal-modules-template). Just fork that repo, add your module and give me a shout via Discord, Github or Email. If it is really unique and convincing, chances are, if you agree, that it will be available as default module in a future release. Please do not attempt to have it merged straight into main. We try not to touch main except for new releases to keep things consistent, stable and easy-to-maintain.
2018-10-02 16:53:48 +02:00
2022-08-27 13:04:53 +02:00
# Code contributions (PRs, hotfixes, Critical improvements)
So you found a bug in Inkycal and tested out a bugfix? Kudos! Please fork the Inkycal repo, add your changes in there and create a PR targeting main. For all other PRs, please target a different branch.
2019-03-22 17:53:35 +01:00
2022-08-27 13:04:53 +02:00
Don't forget to add your name in the file `CONTRIBUTORS.md` of the corresponding branch. Thank You!
2019-03-22 17:53:35 +01:00
2018-10-02 16:53:48 +02:00
# Submitting Issues
2022-08-27 13:04:53 +02:00
Please only submit reproducible issues with clear instructions on how to reproduce them.
2018-10-02 16:53:48 +02:00
When you are submitting a new issue, please supply the following information:
2019-06-02 15:42:49 +02:00
### Release version
2022-08-27 13:04:53 +02:00
* are you using main or a different branch. In most cases, this is main
2018-10-02 16:53:48 +02:00
2022-08-27 13:04:53 +02:00
### Expected behavior and actual behavior
* what were you expecting to happen and what did really happen?
2018-10-02 16:53:48 +02:00
2019-06-02 15:42:49 +02:00
### Steps to reproduce the behavior
2022-08-27 13:04:53 +02:00
* How can the devs re-create the same problem you were having?