From 5b9f505e6cddae02edb51b5edeed649b9089ee24 Mon Sep 17 00:00:00 2001
From: James Elliott <james-d-elliott@users.noreply.github.com>
Date: Wed, 24 Mar 2021 09:50:11 +1100
Subject: [PATCH] docs: add issue templates (#1847)

* docs: add issue templates
* ci: skip .github/ dir
---
 .buildkite/deployment.sh                  |  4 +--
 .buildkite/pipeline.sh                    |  4 +--
 .github/ISSUE_TEMPLATE/bug_report.md      | 41 +++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml         | 11 ++++++
 .github/ISSUE_TEMPLATE/feature_request.md | 26 ++++++++++++++
 .github/ISSUE_TEMPLATE/misc.md            |  7 ++++
 6 files changed, 89 insertions(+), 4 deletions(-)
 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
 create mode 100644 .github/ISSUE_TEMPLATE/misc.md

diff --git a/.buildkite/deployment.sh b/.buildkite/deployment.sh
index 70fa3512a..ad79b3f00 100755
--- a/.buildkite/deployment.sh
+++ b/.buildkite/deployment.sh
@@ -6,9 +6,9 @@ DIVERGED=$(git merge-base --fork-point origin/master > /dev/null; echo $?)
 if [[ $DIVERGED == 0 ]]; then
   if [[ $BUILDKITE_TAG == "" ]]; then
     if [[ $BUILDKITE_BRANCH == "master" ]]; then
-      CI_BYPASS=$(git diff --name-only HEAD~1 | sed -rn '/^(CONTRIBUTING.md|README.md|SECURITY.md|\.all-contributorsrc|docs\/.*)/!{q1}' && echo true || echo false)
+      CI_BYPASS=$(git diff --name-only HEAD~1 | sed -rn '/^(CONTRIBUTING.md|README.md|SECURITY.md|\.all-contributorsrc|\.github\/.*|docs\/.*)/!{q1}' && echo true || echo false)
     else
-      CI_BYPASS=$(git diff --name-only `git merge-base --fork-point origin/master` | sed -rn '/^(CONTRIBUTING.md|README.md|SECURITY.md|\.all-contributorsrc|docs\/.*)/!{q1}' && echo true || echo false)
+      CI_BYPASS=$(git diff --name-only `git merge-base --fork-point origin/master` | sed -rn '/^(CONTRIBUTING.md|README.md|SECURITY.md|\.all-contributorsrc|\.github\/.*|docs\/.*)/!{q1}' && echo true || echo false)
     fi
   else
     CI_BYPASS="false"
diff --git a/.buildkite/pipeline.sh b/.buildkite/pipeline.sh
index e6e9245a8..738763c87 100755
--- a/.buildkite/pipeline.sh
+++ b/.buildkite/pipeline.sh
@@ -6,9 +6,9 @@ DIVERGED=$(git merge-base --fork-point origin/master > /dev/null; echo $?)
 if [[ $DIVERGED == 0 ]]; then
   if [[ $BUILDKITE_TAG == "" ]]; then
     if [[ $BUILDKITE_BRANCH == "master" ]]; then
-      CI_BYPASS=$(git diff --name-only HEAD~1 | sed -rn '/^(CONTRIBUTING.md|README.md|SECURITY.md|\.all-contributorsrc|docs\/.*)/!{q1}' && echo true || echo false)
+      CI_BYPASS=$(git diff --name-only HEAD~1 | sed -rn '/^(CONTRIBUTING.md|README.md|SECURITY.md|\.all-contributorsrc|\.github\/.*|docs\/.*)/!{q1}' && echo true || echo false)
     else
-      CI_BYPASS=$(git diff --name-only `git merge-base --fork-point origin/master` | sed -rn '/^(CONTRIBUTING.md|README.md|SECURITY.md|\.all-contributorsrc|docs\/.*)/!{q1}' && echo true || echo false)
+      CI_BYPASS=$(git diff --name-only `git merge-base --fork-point origin/master` | sed -rn '/^(CONTRIBUTING.md|README.md|SECURITY.md|\.all-contributorsrc|\.github\/.*|docs\/.*)/!{q1}' && echo true || echo false)
     fi
 
     if [[ $CI_BYPASS == "true" ]]; then
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 000000000..76a60c8f8
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,41 @@
+---
+name: Bug Report
+about: Use this template to report bugs other than security vulnerabilities
+labels: Possible Bug
+---
+## Bug Report
+<!--
+1. IMPORTANT: Do not report security vulnerabilities via GitHub issues. Please click 'choose a different type' and see 
+the dedicated report a security vulnerability link.
+2. Remember to customize the title above.
+3. Replace the below sections (not this section) starting with <!- - and ending with - -> with relevant information, 
+making sure to remove the <!- - and - ->.
+4. Sections that start with _N/A_ are optional, but if you populate them with values please remove the _N/A_.
+-->
+
+### Description
+
+<!--
+Describe the bug here.
+-->
+
+### Expected Behaviour
+
+_N/A_
+<!--
+Describe the behaviour your expect here.
+-->
+
+### Reproduction Steps
+
+_N/A_
+<!--
+1. Replace this step with your first step. Add additional steps below this.
+-->
+
+### Additional Information
+
+_N/A_
+<!--
+This section is for relevant additional information like; logs, configurations, environment information, etc. 
+-->
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..68f066acf
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+- name: Documentation
+  url: https://www.authelia.com/docs/
+  about: Read the Documentation
+- name: Matrix
+  url: https://riot.im/app/#/room/#authelia:matrix.org
+  about: Discuss Authelia with the Developers on Matrix which is the preferred method of contact
+- name: Discord
+  url: https://discord.authelia.com
+  about: Discuss Authelia with the Developers on Discord which is bridged to Matrix
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 000000000..4354ccba9
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,26 @@
+---
+name: Feature Request
+about: Use this template to request features
+labels: Feature Request
+---
+## Feature Request
+<!--
+1. IMPORTANT: Do not report security vulnerabilities via GitHub issues. Please click 'choose a different type' and see the dedicated report a security vulnerability link.
+2. Remember to customize the title above.
+3. Replace the below sections (not this section) starting with <!- - and ending with - -> with relevant information, 
+making sure to remove the <!- - and - ->.
+4. Sections that start with _N/A_ are optional, but if you populate them with values please remove the _N/A_.
+-->
+
+### Description
+
+<!--
+Describe the feature here.
+-->
+
+### Use Case
+
+_N/A_
+<!--
+Describe the specific use case if it isn't clear or may not be clear from your feature description here.
+-->
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/misc.md b/.github/ISSUE_TEMPLATE/misc.md
new file mode 100644
index 000000000..23a941098
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/misc.md
@@ -0,0 +1,7 @@
+---
+name: Miscellaneous
+about: Use this template for everything other than feature requests, security vulnerabilities, or bug reports such as questions
+---
+<!--
+IMPORTANT: Do not report security vulnerabilities via GitHub issues. Please click 'choose a different type' and see the dedicated report a security vulnerability link.
+-->
\ No newline at end of file