From 329fe3fb9ef19f2d5a1536dd9adb07434b90f6a5 Mon Sep 17 00:00:00 2001
From: Patrik Kernstock <patrik@kernstock.net>
Date: Sun, 8 Nov 2020 08:36:05 +0000
Subject: [PATCH] Updated issue templates (#3843)

* Updated issue templates

* Small change

* Add labels and emojis

* Added FUNDING.yml, pointing to docs

* Fixed label for feature request template
---
 .github/FUNDING.yml                       |  1 +
 .github/ISSUE_TEMPLATE/Bug_report.md      | 23 +++++++++-------
 .github/ISSUE_TEMPLATE/Feature_request.md | 33 ++++++++++++++++-------
 .github/ISSUE_TEMPLATE/config.yml         |  8 ++++++
 .gitignore                                |  1 -
 5 files changed, 46 insertions(+), 20 deletions(-)
 create mode 100644 .github/FUNDING.yml
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml

diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
new file mode 100644
index 00000000..befe7db7
--- /dev/null
+++ b/.github/FUNDING.yml
@@ -0,0 +1 @@
+custom: https://mailcow.github.io/mailcow-dockerized-docs/#help-mailcow
diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md
index bfe69292..4267ee7d 100644
--- a/.github/ISSUE_TEMPLATE/Bug_report.md
+++ b/.github/ISSUE_TEMPLATE/Bug_report.md
@@ -1,7 +1,7 @@
 ---
-name: Bug report
-about: Report a bug for this project. NOT to be used for support questions.
-
+name: 🐞 Bug Report
+about: Report a reproducible bug for mailcow. (NOT to be used for support questions.)
+labels: bug, Needs triage
 ---
 
 <!--
@@ -11,23 +11,27 @@ about: Report a bug for this project. NOT to be used for support questions.
 -->
 
 **Prior to placing the issue, please check following:** *(fill out each checkbox with an `X` once done)*
-- [ ] I understand, that not following or deleting the below instructions, will result in immediate closing and deletion of my issue.
+- [ ] I understand that not following or deleting the below instructions will result in immediate closure and/or deletion of my issue.
+- [ ] I have understood that this bug report is dedicated for bugs, and not for support-related inquiries.
 - [ ] I have understood that answers are voluntary and community-driven, and not commercial support.
 - [ ] I have verified that my issue has not been already answered in the past. I also checked previous [issues](https://github.com/mailcow/mailcow-dockerized/issues).
 
-**Description of the bug**:
+## Summary
 <!--
   This should be a clear and concise description of what the bug is. What EXACTLY does happen?
   If applicable, add screenshots to help explain your problem. Very useful for bugs in mailcow UI.
   Write your detailed description below.
+
+  Also mention on which commit/date your mailcow instance was last updated.
 -->
 
-**Docker container logs of affected containers**:
+## Logs
 <!--
-  Please take a look at the [official documentation](https://mailcow.github.io/mailcow-dockerized-docs/debug-logs/) and post the last     few lines of logs, when the error occurs.
+  Please take a look at the [official documentation](https://mailcow.github.io/mailcow-dockerized-docs/debug-logs/) and post the last
+  few lines of logs, when the error occurs. For example, docker container logs of affected containers.
 -->
 
-**Reproduction of said bug**:
+## Reproduction
 <!--
   It is really helpful to know how exactly you are able to reproduce the reported issue.
   Have you tried to fix the issue? What did you try?
@@ -35,7 +39,7 @@ about: Report a bug for this project. NOT to be used for support questions.
   Screenshots can be added, if helpful. Add the text below.
 -->
 
-**System information**:
+## System information
 <!--
   In this stage we would kindly ask you to attach general system information about your setup.
   Please carefully read the questions and instructions below.
@@ -54,4 +58,3 @@ about: Report a bug for this project. NOT to be used for support questions.
 - Output of `git diff origin/master`, any other changes to the code? If so, **please post them**.
 - All third-party firewalls and custom iptables rules are unsupported. *Please check the Docker docs about how to use Docker with your own ruleset*. Nevertheless, iptabels output can help us to help you: `iptables -L -vn`, `ip6tables -L -vn`, `iptables -L -vn -t nat` and `ip6tables -L -vn -t nat`.
 - DNS problems? Please run `docker exec -it $(docker ps -qf name=acme-mailcow) dig +short stackoverflow.com @172.22.1.254` (set the IP accordingly, if you changed the internal mailcow network) and post the output.
-
diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md
index 860ab66b..61ddce95 100644
--- a/.github/ISSUE_TEMPLATE/Feature_request.md
+++ b/.github/ISSUE_TEMPLATE/Feature_request.md
@@ -1,14 +1,29 @@
 ---
-name: Feature request
-about: Suggest an idea for this project
-
+name: 💡 Feature Request
+about: Suggest an idea for mailcow.
+labels: enhancement, Needs triage
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+<!--
+  Please note that the mailcow team and its contributors do have finite
+  resources and that we can not work on all filed feature requests.
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+  However making us aware about certain ideas can help us improving
+  mailcow together.
+  
+  We're also happy to help you getting a specific  feature implemented.
+-->
 
-**Additional context**
-Add any other context or screenshots about the feature request here or remove this section
+## Summary
+
+A clear and concise description of what the problem is.
+For example: I'm always frustrated when [...]
+
+## Motivation
+
+What are you about to solve or improve with this idea?
+What would be the benefit for most users?
+
+## Additional context
+
+Add any other context or screenshots about the feature request.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 00000000..51d03700
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: ❓ Community-driven support
+    url: https://mailcow.github.io/mailcow-dockerized-docs/#get-support
+    about: Please use the community forum for questions or assistance
+  - name: 🚨 Report a security vulnerability
+    url: https://www.servercow.de/anfrage?lang=en
+    about: Please give us appropriate time to verify, respond and fix before disclosure.
diff --git a/.gitignore b/.gitignore
index 1feb1072..90e2e496 100644
--- a/.gitignore
+++ b/.gitignore
@@ -50,6 +50,5 @@ data/gitea/
 data/gogs/
 data/conf/sogo/plist_ldap
 update_diffs/
-.github/
 docker-compose.override.yml
 refresh_images.sh