From 0281a6a8b00d1e36940d92fc677bd215436b2a4a Mon Sep 17 00:00:00 2001
From: chgl <chgl@users.noreply.github.com>
Date: Mon, 16 Sep 2024 21:19:44 +0200
Subject: [PATCH] docs: re-org templates

---
 .../{bug_report.md => 1-bug-report.md}        | 21 ++++++++++---------
 ...eature_request.md => 2-feature-request.md} |  7 +++----
 .../ISSUE_TEMPLATE/{custom.md => 3-custom.md} |  9 +++-----
 .../pull-request-template.md}                 |  2 ++
 .markdownlint.json                            | 17 +++++++++++++++
 5 files changed, 36 insertions(+), 20 deletions(-)
 rename .github/ISSUE_TEMPLATE/{bug_report.md => 1-bug-report.md} (69%)
 rename .github/ISSUE_TEMPLATE/{feature_request.md => 2-feature-request.md} (93%)
 rename .github/ISSUE_TEMPLATE/{custom.md => 3-custom.md} (70%)
 rename .github/{pull_request_template.md => PULL_REQUEST_TEMPLATE/pull-request-template.md} (85%)
 create mode 100644 .markdownlint.json

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/1-bug-report.md
similarity index 69%
rename from .github/ISSUE_TEMPLATE/bug_report.md
rename to .github/ISSUE_TEMPLATE/1-bug-report.md
index 912c921a..f3d1ef32 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/1-bug-report.md
@@ -1,10 +1,9 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Describe the bug**
@@ -12,10 +11,11 @@ A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+1. Click on '....'
+1. Scroll down to '....'
+1. See error
 
 **Expected behavior**
 A clear and concise description of what you expected to happen.
@@ -24,9 +24,10 @@ A clear and concise description of what you expected to happen.
 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]
+
+- 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/feature_request.md b/.github/ISSUE_TEMPLATE/2-feature-request.md
similarity index 93%
rename from .github/ISSUE_TEMPLATE/feature_request.md
rename to .github/ISSUE_TEMPLATE/2-feature-request.md
index bbcbbe7d..2bc5d5f7 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/2-feature-request.md
@@ -1,10 +1,9 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
 
 **Is your feature request related to a problem? Please describe.**
diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/3-custom.md
similarity index 70%
rename from .github/ISSUE_TEMPLATE/custom.md
rename to .github/ISSUE_TEMPLATE/3-custom.md
index 75c62db2..166c3d3a 100644
--- a/.github/ISSUE_TEMPLATE/custom.md
+++ b/.github/ISSUE_TEMPLATE/3-custom.md
@@ -1,10 +1,7 @@
 ---
 name: Custom issue template
 about: For anything that isn't a bug or feature request.
-title: ''
-labels: ''
-assignees: ''
-
+title: ""
+labels: ""
+assignees: ""
 ---
-
-
diff --git a/.github/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull-request-template.md
similarity index 85%
rename from .github/pull_request_template.md
rename to .github/PULL_REQUEST_TEMPLATE/pull-request-template.md
index 4f5162c5..69d80f78 100644
--- a/.github/pull_request_template.md
+++ b/.github/PULL_REQUEST_TEMPLATE/pull-request-template.md
@@ -1,5 +1,7 @@
 ## Describe your changes
 
+<!-- It's OK to be brief. Or skip this entirely if the changes are obvious. -->
+
 ## Issue ticket number and link
 
 <!-- Optional -->
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
+}