mirror of
https://github.com/danieldemus/openhab-core.git
synced 2025-01-11 05:41:52 +01:00
48 lines
2.2 KiB
Markdown
48 lines
2.2 KiB
Markdown
<!--
|
|
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 "<!--").
|
|
|
|
ATTENTION: Don't use "git merge" when working with your pull request branch!
|
|
This can clutter your Git history and make your PR unusable.
|
|
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
|
|
|
|
All PRs should be created using the "main" branch as base.
|
|
Important bugfixes are cherry-picked by maintainers to the patch release branch after a PR has been merged.
|
|
|
|
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:
|
|
- Introduce metadata for all add-ons
|
|
- Fix memory leak in ScriptedRuleProvider
|
|
|
|
# Description
|
|
|
|
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 Core README?
|
|
- Does your contribution follow the coding guidelines:
|
|
https://www.openhab.org/docs/developer/guidelines.html
|
|
- Did you check for any (relevant) issues from the static code analysis?
|
|
- Did you sign-off your work:
|
|
https://www.openhab.org/docs/developer/contributing.html#sign-your-work
|
|
|
|
If your pull request contains a new contribution, it will likely take some time
|
|
before it is reviewed and processed by maintainers.
|
|
-->
|