2010-02-20 19:23:32 +01:00
|
|
|
<!--
|
|
|
|
Thanks for contributing to the openHAB project!
|
|
|
|
Please describe the goal and effect of your PR here.
|
|
|
|
Pay attention to the below notes and to *the guidelines* for this repository.
|
|
|
|
Feel free to delete any comment sections in the template (starting with "<!--").
|
|
|
|
|
2022-01-12 08:28:38 +01:00
|
|
|
ATTENTION: Don't use "git merge" when working with your pull request branch!
|
|
|
|
This can clutter your Git history and make your PR unuseable.
|
|
|
|
Use "git rebase" instead. See this forum post for further details:
|
|
|
|
https://community.openhab.org/t/rebase-your-code-or-how-to-fix-your-git-history-before-requesting-a-pull/129358
|
2010-02-20 19:23:32 +01:00
|
|
|
|
2022-01-12 08:28:38 +01:00
|
|
|
Add one or more appropriate labels to make your PR show up in the release notes.
|
|
|
|
E.g. enhancement, bug, documentation, new binding
|
|
|
|
This can only be done by yourself if you already contributed to this repo.
|
2010-02-20 19:23:32 +01:00
|
|
|
|
2022-01-12 08:28:38 +01:00
|
|
|
If your PR's code is not backward compatible with previous releases (which
|
|
|
|
should be avoided), add a message to the release notes by filing another PR:
|
|
|
|
https://github.com/openhab/openhab-distro/blob/main/distributions/openhab/src/main/resources/bin/update.lst
|
|
|
|
|
|
|
|
# Title
|
|
|
|
|
|
|
|
Provide a short summary in the *Title* above. It will show up in the release notes.
|
|
|
|
For example:
|
|
|
|
- [homematic] Improve communication with weak signal devices
|
|
|
|
- [timemachine][WIP] Initial contribution
|
|
|
|
|
|
|
|
# Description
|
2010-02-20 19:23:32 +01:00
|
|
|
|
|
|
|
Please give a few sentences describing the overall goals of the pull request.
|
|
|
|
Give enough details to make the improvement and changes of the PR understandable
|
|
|
|
to both developers and tech-savy users.
|
|
|
|
|
|
|
|
Please keep the following in mind:
|
|
|
|
- What is the classification of the PR, e.g. Bugfix, Improvement, Novel Addition, ... ?
|
|
|
|
- Did you describe the PRs motivation and goal?
|
|
|
|
- Did you provide a link to any prior discussion, e.g. an issue or community forum thread?
|
|
|
|
- Did you describe new features for the end user?
|
|
|
|
- Did you describe any noteworthy changes in usage for the end user?
|
|
|
|
- Was the documentation updated accordingly, e.g. the add-on README?
|
|
|
|
- Does your contribution follow the coding guidelines:
|
2020-09-28 23:10:39 +02:00
|
|
|
https://www.openhab.org/docs/developer/guidelines.html
|
2010-02-20 19:23:32 +01:00
|
|
|
- Did you check for any (relevant) issues from the static code analysis:
|
2020-09-28 23:10:39 +02:00
|
|
|
https://www.openhab.org/docs/developer/bindings/#include-the-binding-in-the-build
|
2010-02-20 19:23:32 +01:00
|
|
|
- Did you sign-off your work:
|
2020-09-28 23:10:39 +02:00
|
|
|
https://www.openhab.org/docs/developer/contributing.html#sign-your-work
|
2010-02-20 19:23:32 +01:00
|
|
|
|
2022-01-12 08:28:38 +01:00
|
|
|
# Testing
|
2010-02-20 19:23:32 +01:00
|
|
|
|
2022-01-12 08:28:38 +01:00
|
|
|
Your pull request will automatically be built and available under the following folder:
|
|
|
|
https://openhab.jfrog.io/ui/native/libs-pullrequest-local/org/openhab/addons/bundles/
|
2010-02-20 19:23:32 +01:00
|
|
|
|
2022-01-12 08:28:38 +01:00
|
|
|
It is a good practice to add a URL to your built JAR in this pull request description,
|
2010-02-20 19:23:32 +01:00
|
|
|
so it is easier for the community to test your Add-on.
|
2022-01-12 08:28:38 +01:00
|
|
|
If your pull request contains a new binding, it will likely take some time
|
2010-02-20 19:23:32 +01:00
|
|
|
before it is reviewed and processed by maintainers.
|
2022-01-12 08:28:38 +01:00
|
|
|
That said, consider submitting your Add-on in the Marketplace:
|
|
|
|
https://community.openhab.org/c/marketplace/69
|
2010-02-20 19:23:32 +01:00
|
|
|
|
|
|
|
Don't forget to submit a thread about your Add-on in the openHAB community:
|
|
|
|
https://community.openhab.org/c/add-ons
|
|
|
|
-->
|