From 4d536379508b1af5c9c42c82d3b82961fe5b5ec0 Mon Sep 17 00:00:00 2001
From: chgl <chgl@users.noreply.github.com>
Date: Mon, 16 Sep 2024 21:26:43 +0200
Subject: [PATCH] docs: added issue and PR template (#99)

* docs: added issue templates

* Update custom.md

* docs: added PR template

* docs: re-org templates

[skip ci]
---
 .github/ISSUE_TEMPLATE/1-bug-report.md        | 33 +++++++++++++++++++
 .github/ISSUE_TEMPLATE/2-feature-request.md   | 19 +++++++++++
 .github/ISSUE_TEMPLATE/3-custom.md            |  7 ++++
 .../pull-request-template.md                  | 15 +++++++++
 .markdownlint.json                            | 17 ++++++++++
 5 files changed, 91 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/1-bug-report.md
 create mode 100644 .github/ISSUE_TEMPLATE/2-feature-request.md
 create mode 100644 .github/ISSUE_TEMPLATE/3-custom.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull-request-template.md
 create mode 100644 .markdownlint.json

diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.md b/.github/ISSUE_TEMPLATE/1-bug-report.md
new file mode 100644
index 00000000..f3d1ef32
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/1-bug-report.md
@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ""
+labels: ""
+assignees: ""
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Go to '...'
+1. Click on '....'
+1. Scroll down to '....'
+1. 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.
+
+**Server (please complete the following information):**
+
+- OS: [e.g. Ubuntu 24.04]
+- Container Runtime [e.g. docker, containerd, cri-o, podman]
+- Container Runtime Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.md b/.github/ISSUE_TEMPLATE/2-feature-request.md
new file mode 100644
index 00000000..2bc5d5f7
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/2-feature-request.md
@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ""
+labels: ""
+assignees: ""
+---
+
+**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**
+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.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/3-custom.md b/.github/ISSUE_TEMPLATE/3-custom.md
new file mode 100644
index 00000000..166c3d3a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/3-custom.md
@@ -0,0 +1,7 @@
+---
+name: Custom issue template
+about: For anything that isn't a bug or feature request.
+title: ""
+labels: ""
+assignees: ""
+---
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull-request-template.md b/.github/PULL_REQUEST_TEMPLATE/pull-request-template.md
new file mode 100644
index 00000000..69d80f78
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/pull-request-template.md
@@ -0,0 +1,15 @@
+## Describe your changes
+
+<!-- It's OK to be brief. Or skip this entirely if the changes are obvious. -->
+
+## Issue ticket number and link
+
+<!-- Optional -->
+
+## Checklist before requesting a review
+
+<!-- It's OK not to update the documentation or create new tests if deemed unnecessary -->
+
+- [ ] The commit message follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] I have made corresponding changes to the documentation
diff --git a/.markdownlint.json b/.markdownlint.json
new file mode 100644
index 00000000..23762ed9
--- /dev/null
+++ b/.markdownlint.json
@@ -0,0 +1,17 @@
+{
+  "MD004": false,
+  "MD007": {
+    "indent": 2
+  },
+  "MD013": {
+    "line_length": 400
+  },
+  "MD026": {
+    "punctuation": ".,;:!。，；:"
+  },
+  "MD029": false,
+  "MD033": false,
+  "MD036": false,
+  "blank_lines": false,
+  "MD041": false
+}