From a59ae6be36322f494f2d861785bf420ba5199321 Mon Sep 17 00:00:00 2001
From: Robert Seedorff <Robert.Seedorff@iteratec.com>
Date: Sat, 20 Mar 2021 15:15:40 +0100
Subject: [PATCH] Improving and bugfixing the github issue templates. Updated
 the release drafter template.

---
 .github/ISSUE_TEMPLATE/bug_report.md          | 15 ++++----
 .github/ISSUE_TEMPLATE/documentation_issue.md | 10 +++--
 .github/ISSUE_TEMPLATE/feature_request.md     | 23 ++++++++----
 .github/ISSUE_TEMPLATE/new_hook.md            | 33 +++++++++--------
 .../ISSUE_TEMPLATE/new_security_scanner.md    | 37 +++++++++++--------
 .github/pull_request_template.md              | 11 +++---
 .github/release-drafter.yml                   | 20 ++++++++--
 7 files changed, 90 insertions(+), 59 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index b267132c26..9ec7340510 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -4,16 +4,18 @@ about: Please create a bug report if you encouter any project specific issue.
 labels: bug
 
 ---
+
+## 🐞 Bug report
 <!--
 Thank you for reporting an issue in our project 🙌
 
 Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead.
 -->
 
-**Describe the bug**
+### Describe the bug
 <!-- A clear and concise description of what the bug is. -->
 
-**To Reproduce**
+### Steps To Reproduce
 <!--
 Steps to reproduce the behavior:
 1. Go to '...'
@@ -22,11 +24,10 @@ Steps to reproduce the behavior:
 4. See error
 -->
 
-**Expected behavior**
+### Expected behavior
 <!-- A clear and concise description of what you expected to happen. -->
 
-
-**System (please complete the following information):**
+### System (please complete the following information):
 <!--
  - secureCodeBox Version/Release
  - OS: [e.g. iOS]
@@ -35,8 +36,8 @@ Steps to reproduce the behavior:
  - Browser [e.g. chrome, safari, firefox,...]
 -->
 
-**Screenshots / Logs**
+### Screenshots / Logs
 <!-- If applicable, add screenshots to help explain your problem. -->
 
-**Additional context**
+### Additional context
 <!-- Add any other context about the problem here. -->
diff --git a/.github/ISSUE_TEMPLATE/documentation_issue.md b/.github/ISSUE_TEMPLATE/documentation_issue.md
index dbdca92cfe..90a57449b8 100644
--- a/.github/ISSUE_TEMPLATE/documentation_issue.md
+++ b/.github/ISSUE_TEMPLATE/documentation_issue.md
@@ -4,17 +4,19 @@ about: "Did you come across parts of our documentation that should be fixed?"
 labels: documentation
 
 ---
+
+## 📚 Documentation Issue
 <!--
 Thank you for reporting an issue in our documentation 🙌
 
 Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead.
 -->
 
-## Where to find the issue
+### Where to find the issue
 <!-- Be as specific as possible by naming the document, page, and ideally paragraph. -->
 
-## Describe the issue
+### Describe the issue
 <!-- Please let us know what exactly is the issue with that part of the documentation -->
 
-## Suggested change
-<!-- If you have ideas on how to fix this issue, please note them here, or consider creating a Pull Request -->
\ No newline at end of file
+### Suggested change
+<!-- If you have ideas on how to fix this issue, please note them here, or consider creating a Pull Request -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index a893c7396b..9c365f8bda 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,22 +1,29 @@
 ---
 name: "➹ Feature request"
 about: "Suggest an idea for this project"
-
+labels: 'enhancement'
 ---
+
+## ➹ New Feature implementation request
 <!--
 Thank you for reporting an issue in our documentation 🙌
 
 Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead.
 -->
 
-**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 [...] -->
+### Is your feature request related to a problem?
+<!-- Please describe a clear and concise description of what the problem is. 
+     Use commmon user story patterns like https://en.wikipedia.org/wiki/User_story:
+      - As a <role> I can <capability>, so that <receive benefit>
+      - In order to <receive benefit> as a <role>, I can <goal/desire>
+      - As <who> <when> <where>, I <want> because <why>
+     For example... As a secureCodeBox user i'm always frustrated when [...] -->
 
-**Describe the solution you'd like**
-<!-- A clear and concise description of what you want to happen. -->
+### Describe the solution you'd like
+<!-- Please describe a clear and concise description of what you want to happen. -->
 
-**Describe alternatives you've considered**
-<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+### Describe alternatives you've considered
+<!-- Please describe a clear and concise description of any alternative solutions or features you've considered. -->
 
-**Additional context**
+### Additional context
 <!-- Add any other context or screenshots about the feature request here. -->
diff --git a/.github/ISSUE_TEMPLATE/new_hook.md b/.github/ISSUE_TEMPLATE/new_hook.md
index ae8d28b25b..24860e37c7 100644
--- a/.github/ISSUE_TEMPLATE/new_hook.md
+++ b/.github/ISSUE_TEMPLATE/new_hook.md
@@ -4,35 +4,38 @@ about: 'Suggest an idea for a new data processing or integration hook in this pr
 labels: 'hook'
 ---
 
+## ⚓️ New Hook implementation request
 <!--
 Thank you for contributing to our project 🙌
 
 Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead. Also, please, have a look at our FAQs and existing questions before opening a new question.
 -->
 
-## New Hook implementation request
+### Is your feature request related to a problem
+<!-- Please describe a clear and concise description of what the problem is. 
+     Use commmon user story patterns like https://en.wikipedia.org/wiki/User_story:
+      - As a <role> I can <capability>, so that <receive benefit>
+      - In order to <receive benefit> as a <role>, I can <goal/desire>
+      - As <who> <when> <where>, I <want> because <why>
+     For example... As a secureCodeBox user i'm always frustrated when [...] -->
 
-**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 [...] -->
-
-**Describe the solution you'd like**
+### Describe the solution you'd like
 <!-- A clear and concise description of what you want to happen. -->
 
-**Describe alternatives you've considered**
+### Describe alternatives you've considered
 <!-- A clear and concise description of any alternative solutions or features you've considered. -->
 
-**Additional context**
+### Additional context
 <!-- Add any other context or screenshots about the feature request here. -->
 
-## Steps to implement a new Hook
-<!--
-Hint: A general guide how to implement a new scanner is documented [here](https://github.com/secureCodeBox/secureCodeBox/tree/master/docs/developer-guide)
--->
+## Steps to implement a new hook
+Hint: A general guide how to implement a new SCB Hook is documented [here](https://docs.securecodebox.io/docs/contributing/integrating-a-hook)
 
 - [ ] Create a new folder with the name of the [hook here](https://github.com/secureCodeBox/secureCodeBox/tree/master/hooks)
-- [ ] Add a README and give a brief overview of the scanner and its configuration options.
-- [ ] Add (optional) a Dockerfile for the scanner if there is no existing one publicly available on dockerHub
+- [ ] Add a `README.md` and give a brief overview of the scanner and its configuration options.
+- [ ] Add a HelmChart and document all configuration options.
+- [ ] Add (optional) a `Dockerfile` for the scanner if there is no existing one publicly available on dockerHub.io
 - [ ] Use the [Hook-SDK](https://github.com/secureCodeBox/secureCodeBox/tree/master/hook-sdk) to implement a new hook (currently based on NodeJS)
 - [ ] Add unit tests with at minimum 80% test coverage
-- [ ] Add some example scan.yaml and finding.yaml files in the example folder
-- [ ] Implement a new integration test for the hook [here](https://github.com/secureCodeBox/secureCodeBox/tree/master/tests/integration)
+- [ ] Add some example `scan.yaml` and `finding.yaml` files in the example folder
+- [ ] Implement a [new integration or E2E test](https://docs.securecodebox.io/docs/contributing/integrating-a-hook/integration-tests) for the hook [here](https://github.com/secureCodeBox/secureCodeBox/tree/master/tests/integration)
diff --git a/.github/ISSUE_TEMPLATE/new_security_scanner.md b/.github/ISSUE_TEMPLATE/new_security_scanner.md
index a23180f7ad..8325ddd349 100644
--- a/.github/ISSUE_TEMPLATE/new_security_scanner.md
+++ b/.github/ISSUE_TEMPLATE/new_security_scanner.md
@@ -1,39 +1,44 @@
 ---
-name: '🚓 New Security Scanner request'
+name: '🚓  New Security Scanner request'
 about: 'Suggest an idea for a new security scanner to integrate in this project.'
 labels: 'scanner'
 ---
 
+## 🚓  New Scanner implementation request
 <!--
 Thank you for contributing to our project 🙌
 
 Before opening a new issue, please make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead. Also, please, have a look at our FAQs and existing questions before opening a new question.
 -->
 
-## New Scanner implementation request
+### Is your feature request related to a problem
+<!-- Please describe a clear and concise description of what the problem is. 
+     Use commmon user story patterns like https://en.wikipedia.org/wiki/User_story:
+      - As a <role> I can <capability>, so that <receive benefit>
+      - In order to <receive benefit> as a <role>, I can <goal/desire>
+      - As <who> <when> <where>, I <want> because <why>
+     For example... As a secureCodeBox user i'm always frustrated when [...] -->
 
-**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 [...] -->
-
-**Describe the solution you'd like**
+### Describe the solution you'd like
 <!-- A clear and concise description of what you want to happen. -->
 
-**Describe alternatives you've considered**
+### Describe alternatives you've considered
 <!-- A clear and concise description of any alternative solutions or features you've considered. -->
 
-**Additional context**
+### Additional context
 <!-- Add any other context or screenshots about the feature request here. -->
 
 ## Steps to implement a new scanner
-<!--
-Hint: A general guide how to implement a new scanner is documented [here](https://github.com/secureCodeBox/secureCodeBox/tree/master/docs/developer-guide)
--->
+Hint: A general guide how to implement a new SCB scanner is documented [here](https://docs.securecodebox.io/docs/contributing/integrating-a-scanner)
 
 - [ ] Create a new folder with the name of the [scanner here](https://github.com/secureCodeBox/secureCodeBox/tree/master/scanners)
-- [ ] Add a README.md and give a brief overview of the scanner and its configuration options.
-- [ ] Implement a new scanner specific scan-type.yaml
-- [ ] Implement a new scanner specific parse-definition.yaml
-- [ ] Add (optional) some cascading-rules.yaml
-- [ ] Add (optional) a Dockerfile for the scanner if there is no existing one publicly available on dockerHub
+- [ ] Add a `README.gotmpl` and give a [brief overview](https://docs.securecodebox.io/docs/contributing/integrating-a-scanner/readme) of the scanner and its configuration options.
+- [ ] Add a HelmChart and document all configuration options.
+- [ ] Implement a new scanner specific `scan-type.yaml`
+- [ ] Implement a new scanner specific `parse-definition.yaml`
+- [ ] Add (optional) some `cascading-rules.yaml` like documented [here](https://docs.securecodebox.io/docs/api/crds/cascading-rule)
+- [ ] Add (optional) a `Dockerfile` for the scanner if there is no existing one publicly available on dockerHub
 - [ ] Use the [parser-SDK](https://github.com/secureCodeBox/secureCodeBox/tree/master/parser-sdk) to implement a new findings parser (currently based on NodeJS)
 - [ ] Add unit tests with at minimum 80% test coverage
+- [ ] Add some example `scan.yaml` and `finding.yaml` files in the [example folder](https://docs.securecodebox.io/docs/contributing/integrating-a-scanner/examples-dir)
+- [ ] Implement a [new integration or E2E test](https://docs.securecodebox.io/docs/contributing/integrating-a-scanner/integration-tests) for the hook [here](https://github.com/secureCodeBox/secureCodeBox/tree/master/tests/integration)
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 75373f8527..d6238ca51e 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -10,11 +10,12 @@ Before submitting your Pull Request, please take the time to check the points be
 * [ ] Make sure each new source file you add has a correct license header.
 -->
 
-## Checklist
+## Description
+<!-- Please be brief in describing which issue is solved by your PR or which enhancement it brings -->
 
-* [ ] Test your changes as thoroughly as possible before you commit them. Preferably, automate your test by unit/integration tests.
-* [ ] Make sure `npm test` runs for the whole project.
 
-## Description
+### Checklist
 
-<!-- Please be brief in describing which issue is solved by your PR or which enhancement it brings -->
\ No newline at end of file
+* [ ] Test your changes as thoroughly as possible before you commit them. Preferably, automate your test by unit/integration tests.
+* [ ] Make sure `npm test` runs for the whole project.
+* [ ] Make codeclimate checks happy
diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
index eeb02b0400..d7ed3f31dc 100644
--- a/.github/release-drafter.yml
+++ b/.github/release-drafter.yml
@@ -3,18 +3,30 @@ tag-template: 'v$NEXT_PATCH_VERSION'
 categories:
   - title: '🚀 Features'
     label: 'enhancement'
+  - title: '🕷 Security Scanner'
+    label: 'security scanner'
+  - title: '⚓️ Hooks'
+    label: 'hook'
   - title: '🐛 Bug Fixes'
     label: 'bug'
-  - title: '🔧 Maintenance'
-    label: 'maintenance'
   - title: '🧪 Test'
-    label: 'test'
-  - title: '🧪 Documentation'
+    labels: 
+      - 'test'
+      - 'testing' 
+  - title: '📚 Documentation'
     label: 'docs'
+  - title: '🔧 Maintenance'
+    label: 'maintenance'
   - title: '📌 Dependencies'
     label: 'dependencies'
 change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
 exclude-labels:
   - 'skip-changelog'
 template: |
+  ## Changes
+  This release contains the following changes. 
   $CHANGES
+
+  ## Contributers
+  Thx to all our contributers supporting this project 🤗
+  $CONTRIBUTORS