From 9c194ee93329571cbeba239e4e1a3b11584d3ee5 Mon Sep 17 00:00:00 2001
From: Felix Angelov <felangelov@gmail.com>
Date: Thu, 16 May 2024 21:25:38 -0500
Subject: [PATCH] chore: add issue and pull request templates

---
 .github/CODEOWNERS                        |  3 +++
 .github/FUNDING.yml                       |  2 ++
 .github/ISSUE_TEMPLATE/bug_report.md      | 25 ++++++++++++++++++
 .github/ISSUE_TEMPLATE/build.md           | 10 +++++++
 .github/ISSUE_TEMPLATE/chore.md           | 10 +++++++
 .github/ISSUE_TEMPLATE/ci.md              | 10 +++++++
 .github/ISSUE_TEMPLATE/config.yml         |  1 +
 .github/ISSUE_TEMPLATE/documentation.md   | 10 +++++++
 .github/ISSUE_TEMPLATE/feature_request.md | 22 ++++++++++++++++
 .github/ISSUE_TEMPLATE/performance.md     | 10 +++++++
 .github/ISSUE_TEMPLATE/refactor.md        | 10 +++++++
 .github/ISSUE_TEMPLATE/revert.md          | 10 +++++++
 .github/ISSUE_TEMPLATE/style.md           | 10 +++++++
 .github/ISSUE_TEMPLATE/test.md            | 10 +++++++
 .github/PULL_REQUEST_TEMPLATE.md          | 32 +++++++++++++++++++++++
 15 files changed, 175 insertions(+)
 create mode 100644 .github/CODEOWNERS
 create mode 100644 .github/FUNDING.yml
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/build.md
 create mode 100644 .github/ISSUE_TEMPLATE/chore.md
 create mode 100644 .github/ISSUE_TEMPLATE/ci.md
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml
 create mode 100644 .github/ISSUE_TEMPLATE/documentation.md
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
 create mode 100644 .github/ISSUE_TEMPLATE/performance.md
 create mode 100644 .github/ISSUE_TEMPLATE/refactor.md
 create mode 100644 .github/ISSUE_TEMPLATE/revert.md
 create mode 100644 .github/ISSUE_TEMPLATE/style.md
 create mode 100644 .github/ISSUE_TEMPLATE/test.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md

diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
new file mode 100644
index 0000000..813d7e6
--- /dev/null
+++ b/.github/CODEOWNERS
@@ -0,0 +1,3 @@
+# Every request must be reviewed and accepted by:
+
+*	@felangel
\ No newline at end of file
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
new file mode 100644
index 0000000..1b8b72d
--- /dev/null
+++ b/.github/FUNDING.yml
@@ -0,0 +1,2 @@
+github: [felangel]
+patreon: felangel
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..5f2fb38
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,25 @@
+---
+name: Bug Report
+about: Create a report to help us improve
+title: "fix: "
+labels: bug
+---
+
+**Description**
+A clear and concise description of what the bug is.
+
+**Steps To Reproduce**
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected Behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional Context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/build.md b/.github/ISSUE_TEMPLATE/build.md
new file mode 100644
index 0000000..16906a4
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/build.md
@@ -0,0 +1,10 @@
+---
+name: Build System
+about: Changes that affect the build system or external dependencies
+title: "build: "
+labels: build
+---
+
+**Description**
+
+Describe what changes need to be done to the build system and why
diff --git a/.github/ISSUE_TEMPLATE/chore.md b/.github/ISSUE_TEMPLATE/chore.md
new file mode 100644
index 0000000..60bb002
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/chore.md
@@ -0,0 +1,10 @@
+---
+name: Chore
+about: Other changes that don't modify src or test files
+title: "chore: "
+labels: chore
+---
+
+**Description**
+
+Clearly describe what change is needed and why. If this changes code then please use another issue type.
diff --git a/.github/ISSUE_TEMPLATE/ci.md b/.github/ISSUE_TEMPLATE/ci.md
new file mode 100644
index 0000000..7f40811
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/ci.md
@@ -0,0 +1,10 @@
+---
+name: Continuous Integration
+about: Changes to the CI configuration files and scripts
+title: "ci: "
+labels: ci
+---
+
+**Description**
+
+Describe what changes need to be done to the ci/cd system and why
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..ec4bb38
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: false
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
new file mode 100644
index 0000000..c8a702e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation.md
@@ -0,0 +1,10 @@
+---
+name: Documentation
+about: Improve the documentation so all collaborators have a common understanding
+title: "docs: "
+labels: documentation
+---
+
+**Description**
+
+Clearly describe what documentation you are looking to add or improve.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..522f253
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,22 @@
+---
+name: Feature Request
+about: A new feature to be added to the project
+title: "feat: "
+labels: feature
+---
+
+**Description**
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Desired Solution**
+
+A clear and concise description of what you want to happen.
+
+**Alternatives Considered**
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional Context**
+
+Add any other context or screenshots about the feature request go here.
diff --git a/.github/ISSUE_TEMPLATE/performance.md b/.github/ISSUE_TEMPLATE/performance.md
new file mode 100644
index 0000000..207b798
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/performance.md
@@ -0,0 +1,10 @@
+---
+name: Performance Update
+about: A code change that improves performance
+title: "perf: "
+labels: performance
+---
+
+**Description**
+
+Clearly describe what code needs to be changed and what the performance impact is going to be.
diff --git a/.github/ISSUE_TEMPLATE/refactor.md b/.github/ISSUE_TEMPLATE/refactor.md
new file mode 100644
index 0000000..f23103d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/refactor.md
@@ -0,0 +1,10 @@
+---
+name: Refactor
+about: A code change that neither fixes a bug nor adds a feature
+title: "refactor: "
+labels: refactor
+---
+
+**Description**
+
+Clearly describe what needs to be refactored any why. Please provide links to related issues (bugs or upcoming features) in order to help prioritize.
diff --git a/.github/ISSUE_TEMPLATE/revert.md b/.github/ISSUE_TEMPLATE/revert.md
new file mode 100644
index 0000000..65d71c5
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/revert.md
@@ -0,0 +1,10 @@
+---
+name: Revert Commit
+about: Reverts a previous commit
+title: "revert: "
+labels: revert
+---
+
+**Description**
+
+Provide a link to a PR/Commit that you are looking to revert and why.
diff --git a/.github/ISSUE_TEMPLATE/style.md b/.github/ISSUE_TEMPLATE/style.md
new file mode 100644
index 0000000..d35b765
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/style.md
@@ -0,0 +1,10 @@
+---
+name: Style Changes
+about: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+title: "style: "
+labels: style
+---
+
+**Description**
+
+Clearly describe what you are looking to change and why.
diff --git a/.github/ISSUE_TEMPLATE/test.md b/.github/ISSUE_TEMPLATE/test.md
new file mode 100644
index 0000000..464857c
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/test.md
@@ -0,0 +1,10 @@
+---
+name: Test
+about: Adding missing tests or correcting existing tests
+title: "test: "
+labels: test
+---
+
+**Description**
+
+List out the tests that need to be added or changed. Please also include any information as to why this was not covered in the past.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..def3db7
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,32 @@
+<!--
+  Thanks for contributing!
+
+  Provide a description of your changes below and a general summary in the title
+
+  Please look at the following checklist to ensure that your PR can be accepted quickly:
+-->
+
+## Status
+
+**READY/IN DEVELOPMENT/HOLD**
+
+## Breaking Changes
+
+YES | NO
+
+## Description
+
+<!--- Describe your changes in detail -->
+
+## Type of Change
+
+<!--- Put an `x` in all the boxes that apply: -->
+
+- [ ] ✨ New feature (non-breaking change which adds functionality)
+- [ ] 🛠️ Bug fix (non-breaking change which fixes an issue)
+- [ ] ❌ Breaking change (fix or feature that would cause existing functionality to change)
+- [ ] 🧹 Code refactor
+- [ ] ✅ Build configuration change
+- [ ] 📝 Documentation
+- [ ] 🧪 Tests
+- [ ] 🗑️ Chore