From b745d70d6db9224609acb12192428966f6ef1fc1 Mon Sep 17 00:00:00 2001
From: Wouter Born <github@maindrain.net>
Date: Sat, 1 Apr 2023 14:39:25 +0200
Subject: [PATCH] Add issue and pull request templates and configuration
 (#3463)

Signed-off-by: Wouter Born <github@maindrain.net>
---
 .github/ISSUE_TEMPLATE/bug_report.md          | 45 ++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml             | 11 +++++
 .github/ISSUE_TEMPLATE/feature_request.md     | 17 +++++++
 .../sitemap_change.md                         |  2 +-
 .github/PULL_REQUEST_TEMPLATE.md              | 47 +++++++++++++++++++
 5 files changed, 121 insertions(+), 1 deletion(-)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
 rename .github/{issue_template => ISSUE_TEMPLATE}/sitemap_change.md (96%)
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 000000000..4c292a99f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,45 @@
+---
+name: "🐛 Bug report"
+about: Something isn't working correctly in the Core. This is the wrong place for openHAB user-interface or add-on issues
+labels: bug
+
+---
+
+<!-- Provide a general summary of the issue in the *Title* above -->
+
+<!-- Important: Please contact the openHAB community forum for questions or -->
+<!-- for configuration and usage guidance: https://community.openhab.org -->
+
+<!-- Feel free to delete any comment lines in the template (starting with "<!--") -->
+
+## Expected Behavior
+<!-- If you're describing a bug, tell us what should happen -->
+<!-- If you're suggesting a change/improvement, tell us how it should work -->
+
+## Current Behavior
+<!-- If describing a bug, tell us what happens instead of the expected behavior -->
+<!-- Include related log information (preferably debug level) and related configs -->
+<!-- Use a file attachment for log and config information longer than a few lines -->
+<!-- Enclose multi-line log/code snippets with ``` on new lines for proper formatting -->
+<!-- If suggesting a change/improvement, explain the difference from current behavior -->
+<!-- For improvements, discuss at community.openhab.org first and include link to topic -->
+
+## Possible Solution
+<!-- Not obligatory, but suggest a fix/reason for the bug, -->
+<!-- or ideas how to implement the addition or change -->
+
+## Steps to Reproduce (for Bugs)
+<!-- Provide a link to a live example, or an unambiguous set of steps to -->
+<!-- reproduce this bug. Include code to reproduce, if relevant -->
+1.
+2.
+
+## Context
+<!-- How has this issue affected you? What are you trying to accomplish? -->
+<!-- Providing context helps us come up with a solution that is most useful in the real world -->
+
+## Your Environment
+<!-- Include as many relevant details about the environment you experienced the bug in -->
+* Version used: (e.g., openHAB and add-on versions)
+* Environment name and version (e.g. Chrome 111, Java 17, Node.js 18.15, ...):
+* Operating System and version (desktop or mobile, Windows 11, Raspbian Bullseye, ...):
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..b8c32b012
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,11 @@
+blank_issues_enabled: true
+contact_links:
+  - name: 🤔 Support/Usage Question
+    url: https://community.openhab.org
+    about: Feel free to ask anything
+  - name: 📖 Documentation
+    url: https://www.openhab.org/docs/
+    about: Official documentation
+  - name: 📚 Translation feedback
+    url: https://crowdin.com/project/openhab-core
+    about: Share feedback on translations
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 000000000..161681372
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,17 @@
+---
+name: "✨ Feature request"
+about: You think that the Core should gain another feature
+labels: enhancement
+
+---
+
+<!-- Provide a general summary of the feature request in the *Title* above -->
+
+<!-- Important: Please contact the openHAB community forum for questions or -->
+<!-- for configuration and usage guidance: https://community.openhab.org -->
+
+## Your Environment
+<!-- Include as many relevant details about the environment when applicable -->
+* Version used: (e.g., openHAB and add-on versions)
+* Environment name and version (e.g. Chrome 111, Java 17, Node.js 18.15, ...):
+* Operating System and version (desktop or mobile, Windows 11, Raspbian Bullseye, ...):
diff --git a/.github/issue_template/sitemap_change.md b/.github/ISSUE_TEMPLATE/sitemap_change.md
similarity index 96%
rename from .github/issue_template/sitemap_change.md
rename to .github/ISSUE_TEMPLATE/sitemap_change.md
index 52975ceb2..783ca7574 100644
--- a/.github/issue_template/sitemap_change.md
+++ b/.github/ISSUE_TEMPLATE/sitemap_change.md
@@ -1,5 +1,5 @@
 ---
-name: Suggest a Sitemap change
+name: 🗺  Sitemap change
 about: 'Suggest a change in the Sitemap syntax and corresponding UIs'
 labels: sitemap
 ---
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 000000000..c01cdb58c
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,47 @@
+<!--
+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.
+-->