Merge pull request #121 from BurningEnlightenment/dev/templates

chore: Add issue and pull request templates

Author: Holzhaus

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,43 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: type:bug
+assignees: ''
+
+---
+<!--
+Note: Please search the issue tracker to see if the bug you've encountered has
+already been reported.
+-->
+
+### Current Behavior
+<!-- A concise description of what you're experiencing. -->
+
+### Expected Behavior
+<!-- A concise description of what you expected to happen. -->
+
+### Reproduction Steps
+<!--
+Steps to reproduce the behavior or a minimal (if possible self contained)
+reproducing code snippet. Example:
+steps to reproduce the behavior:
+1. In this environment...
+1. With this config...
+1. Run '...'
+1. See error...
+-->
+
+### Environment
+<!--
+Example:
+- OS: Ubuntu 20.04
+- Python: 3.11.3
+- Project Version (or commit ID): 0.2.4
+-->
+
+### Additional Context
+<!--
+Links? References? Anything that will give us more context about the issue that
+you are encountering!
+-->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,34 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: type:task
+assignees: ''
+
+---
+<!--
+Note: Please search the issue tracker to see if this feature has already been
+requested.
+-->
+
+### Problem Description
+<!--
+Is your feature request related to a problem?
+Add a clear and concise description of what the problem is.
+Ex. I'm always frustrated when [...]
+-->
+
+### Proposed Solution
+<!-- Describe the solution you'd like to see implemented -->
+
+### Possible Alternative Approaches
+<!--
+Describe alternative solutions or workarounds you've considered -->
+A clear and concise description of any alternative solutions or features you've
+considered and how they differ from your preferred solution.
+
+### Additional Context
+<!--
+Links? References? Anything that will give us more context about the problem
+that you want to be solved!
+-->

.github/pull_request_template.md

@@ -0,0 +1,31 @@
+<!--
+**IMPORTANT: Please do not create a Pull Request without creating an issue first.**
+
+Any change needs to be discussed before proceeding.
+Failure to do so may result in the rejection of the pull request.
+Fixing minuscule documentation issues or typos is an exception to this rule.
+
+I recommend removing these comments before submitting.
+
+Please provide enough information so that others can review your pull request:
+-->
+
+### Purpose
+<!--
+Explain the **motivation** for making this change. What existing problem does
+the pull request solve? This could be a short summary of the motivating issue.
+
+
+You may remove this if you're fixing a typo.
+-->
+
+Resolves #XXX <!-- associate the motivating issue -->
+
+
+### Solution Sketch
+<!--
+Outline the design decisions leading to this very change set.
+-->
+
+
+### Additional explanatory comments

.pre-commit-config.yaml

@@ -49,6 +49,7 @@ repos:
   rev: v0.12.0
   hooks:
   - id: markdownlint
+    exclude: ^\.github/(ISSUE_TEMPLATE/.*|pull_request_template)\.md$
 - repo: https://github.com/Holzhaus/sourceheaders
   rev: v0.0.4
   hooks: