GitHub issue and pull request templates

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,13 @@
+<!-- Click on the "Preview" tab to render the instructions in a more readable format -->
+
+> **Please read the [contribution guidelines](https://github.com/arcticicestudio/snowsaw/blob/develop/CONTRIBUTING.md) before filling out this issue template**.
+
+## [Please follow one of the issue templates](https://github.com/arcticicestudio/snowsaw/issues/new/choose)
+
+To keep the backlog clean and actionable, issues should be opened using [one the provided issue templates](https://github.com/arcticicestudio/snowsaw/issues/new/choose) to help maintainers and the community to understand it, find related reports and to resolve tickets faster.
+
+### Support
+
+If you got a question or need help with any aspect of the project feel free to [join the community](https://spectrum.chat/arcticicestudio/snowsaw), write us on [Twitter](https://twitter.com/arcticicestudio) and ensure to read the [project documentations](https://github.com/arcticicestudio/snowsaw).
+
+You can also search for already opened and related issue using the search for the [“question“](https://github.com/arcticicestudio/snowsaw/labels/type-question) issue label.

.github/ISSUE_TEMPLATE/bugs.md

@@ -0,0 +1,84 @@
+---
+name: Bug Report
+about: Report a bug that is caused by the code in this repository
+---
+
+<!-- Click on the "Preview" tab to render the instructions in a more readable format -->
+
+> **Please read the [contribution guidelines](https://github.com/arcticicestudio/snowsaw/blob/develop/CONTRIBUTING.md) before filling out this issue template**.
+
+## Prerequisites
+
+This section and the instructions in the sections below are only part of this issue template. Please ensure to **delete this whole section, all pre-filled instructions of the sections below and sections you have not filled out before submitting** to ensure a clear structure and overview.
+
+Please do your best to provide as much information as possible and use a clear and descriptive title for your bug report to help maintainers and the community understand and reproduce the behavior, find related reports and to resolve the ticket faster.
+
+- **Ensure the bug has not already been reported by using the [GitHub Issues search](https://github.com/arcticicestudio/snowsaw/issues)** — check if this enhancement has already been suggested. If it has **and the issue is still open**, add your additions as comment to the existing issue instead of opening a new one. If you find a closed issue that seems to be similar to this one, include a link to the original issue in the [metadata head](#metadata-head) section of this issue.
+- **Ensure the bug is reproducible and has not already been fixed** — use the [latest version](https://github.com/arcticicestudio/snowsaw/releases/latest) and [`develop`](https://github.com/arcticicestudio/snowsaw/tree/develop) branch.
+
+## Metadata Head
+
+The metadata head can be added to the top of the issue as [Markdown text quote](https://help.github.com/articles/basic-writing-and-formatting-syntax) containing the the ID of other related issues.
+
+> Related issues:
+
+## Description
+
+Describe the bug as in many relevant details as possible with a clear and concise description. Ensure to fill in the [steps to reproduce](#steps-to-reproduce) it.
+
+### Steps to Reproduce
+
+1. Step One
+2. Step Two
+3. ...
+
+### Expected Behavior
+
+What you expect to happen?
+
+### Actual Behavior
+
+What actually happens?
+
+## Example
+
+Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/snowsaw/blob/develop/CONTRIBUTING.md#mcve)
+
+**This is a optional section, but it can drastically increase the speed at which this issue can be processed since it takes away the time-consuming reconstruction to reproduce the bug.**
+The recommended way is to upload it as [Gist](https://gist.github.com) or new repository to GitHub, but of course you can [attach it to this issue](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests), use any free file hosting service or paste the code in [Markdown code blocks](https://help.github.com/articles/basic-writing-and-formatting-syntax) into this issue.
+
+## Environment and Versions
+
+- What is the version of snowsaw you are running?
+- What is the name and the version of your OS?
+  - Have you tried to reproduce it on different OS environments and if yes, is the behavior the same for all?
+- Please provide the version of your [Go](https://golang.org) runtime.
+  - Are you using any additional CLI arguments to run the project?
+- If you've installed the [mage](https://github.com/magefile/mage) build tool locally on your system, please specify the version.
+  - Are you using any additional CLI arguments to start `mage` tasks other than defined by the project documentation?
+
+Please run the following command **from within the project root** and paste the output in the code block below: `go env`
+
+```md
+Paste output of the command here.
+```
+
+## Stack Trace and Error Messages
+
+```raw
+Paste the full stack trace, error messages or the logfile here.
+```
+
+... or [attach them as files](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests) to this issue.
+
+## Additional Context
+
+Add any other context, screenshots or screencasts which are relevant for this issue.
+
+## References
+
+Add any other references and links which are relevant for this issue.
+
+## Potential Solution
+
+Maybe include the lines of code that you have identified as causing the bug or references to other projects where this bug has already been reported.

.github/ISSUE_TEMPLATE/enhancement.md

@@ -0,0 +1,58 @@
+---
+name: Enhancement Suggestions
+about: Submit an enhancement suggestion for new features or minor improvements to existing functionality
+---
+
+<!-- Click on the "Preview" tab to render the instructions in a more readable format -->
+
+> **Please read the [contribution guidelines](https://github.com/arcticicestudio/snowsaw/blob/develop/CONTRIBUTING.md) before filling out this issue template**.
+
+## Prerequisites
+
+This section and the instructions in the sections below are only part of this issue template. Please ensure to **delete this whole section, all pre-filled instructions of the sections below and sections you have not filled out before submitting** to ensure a clear structure and overview.
+
+Please do your best to provide as much information as possible and use a clear and descriptive title for your enhancement suggestion to help maintainers and the community understand and reproduce the behavior, find related reports and to resolve the ticket faster.
+
+- **Ensure the enhancement has not already been reported by using the [GitHub Issues search](https://github.com/arcticicestudio/snowsaw/issues)** — check if this enhancement has already been suggested. If it has **and the issue is still open**, add your additions as comment to the existing issue instead of opening a new one. If you find a closed issue that seems to be similar to this one, include a link to the original issue in the [metadata head](#metadata-head) section of this issue.
+- **Check if the enhancement has already been implemented** — use the [latest version](https://github.com/arcticicestudio/snowsaw/releases/latest) and [`develop`](https://github.com/arcticicestudio/snowsaw/tree/develop) branch to ensure that the feature or improvement has not already been added.
+
+## Metadata Head
+
+The metadata head can be added to the top of the issue as [Markdown text quote](https://help.github.com/articles/basic-writing-and-formatting-syntax) containing the ID of other related issues.
+
+> Related issues:
+
+## Description
+
+Describe the enhancement in many relevant details as possible.
+
+### Benefits
+
+Add specific use-cases and explain why this feature or improvement would be useful and maybe include references to related known problems or bug reports.
+
+### Possible Drawbacks
+
+Describe possible negative impacts regarding e.g. functionality or usability.
+
+### Alternative Solutions
+
+If you've considered alternative features or solutions please describe it clearly and concise.
+
+## Example
+
+Provide a [MCVE - The Minimal, Complete, and Verifiable Example](https://github.com/arcticicestudio/snowsaw/blob/develop/CONTRIBUTING.md#mcve)
+
+**This is a optional section, but it can drastically increase the speed at which this issue can be processed since it takes away the time-consuming reconstruction to reproduce the enhancement.**
+The recommended way is to upload it as [Gist](https://gist.github.com) or new repository to GitHub, but of course you can [attach it to this issue](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests), use any free file hosting service or paste the code in [Markdown code blocks](https://help.github.com/articles/basic-writing-and-formatting-syntax) into this issue.
+
+## Additional Context
+
+Add any other context, screenshots or screencasts which are relevant for this issue.
+
+## References
+
+Add any other references and links which are relevant for this issue.
+
+## Potential Solution
+
+Maybe include references to other projects where this enhancement already exists.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,28 @@
+<!-- Click on the "Preview" tab to render the instructions in a more readable format -->
+
+> **Please read the [contribution guidelines](https://github.com/arcticicestudio/snowsaw/blob/develop/CONTRIBUTING.md) before filling out this issue template**.
+
+## Prerequisites
+
+This section and the instructions in the sections below are only part of this pull request template. Please ensure to **delete this whole section, all pre-filled instructions of the sections below and sections you have not filled out before submitting** to ensure a clear structure and overview.
+
+Please do your best to provide as much information as possible and use a clear and descriptive title for your enhancement suggestion or bug fix to help maintainers and the community understand and reproduce the behavior, find related pull requests and to merge it faster.
+
+- **Ensure the pull request has not already been submitted by using the [GitHub Issue search](https://github.com/arcticicestudio/snowsaw/issues)** — check if this enhancement or bug fix has already been suggested. If it has **and the pull request is still open**, add your additions as comment or [suggest a change](https://help.github.com/articles/incorporating-feedback-in-your-pull-request/#applying-a-suggested-change) to the existing pull request instead of opening a new one. If you find a closed pull request that seems to be similar to this one, include a link to the original pull request in the [metadata head](#metadata-head) section of this new pull request.
+- **Ensure to adhere to the [pull request contribution guidelines](https://github.com/arcticicestudio/snowsaw/blob/develop/CONTRIBUTING.md#pull-requests)**, especially the one for tests and documentations.
+- **Check if the enhancement has already been implemented or bug already fixed** — use the [latest version](https://github.com/arcticicestudio/snowsaw/releases/latest) and [`develop`](https://github.com/arcticicestudio/snowsaw/tree/develop) branch to ensure that the enhancement or bug fix has not already been added.
+
+## Metadata Head
+
+The metadata head should be added to the top of the pull request as [Markdown text quote](https://help.github.com/articles/basic-writing-and-formatting-syntax) containing the [GitHub issue keyword(s)](https://help.github.com/articles/closing-issues-using-keywords) to link to the related enhancements suggestions (`Closes`) or bug reports (`Fixes`). You can add additional details like dependencies to other pull requests and the order it needs to be merged.
+
+> Closes ISSUE_ID  
+> Must be merged **after**/**before** ISSUE_ID
+
+## Description
+
+Describe the changes as in many relevant details as possible. If this is a enhancement suggestion add specific use-cases and explain why this feature or improvement would be useful. If this is a bug fix ensure to provide a _before/after_ comparison by describing the current behavior and the new behavior.
+
+## References
+
+Add any other references and links which are relevant for this pull request.