github: Use Markdown and slight changes to PR template
authorJosef Schlehofer <[email protected]>
Mon, 2 Jun 2025 11:17:12 +0000 (13:17 +0200)
committerJosef Schlehofer <[email protected]>
Mon, 2 Jun 2025 18:06:52 +0000 (20:06 +0200)
The previous pull request was kinda not exactly tested.
This one should be better and more visible.

Fixes: 9a273c3e79ec1018aea4fe9bc338d679f5553bee ("github: Improve Pull Request template")
Signed-off-by: Josef Schlehofer <[email protected]>
.github/pull_request_template [deleted file]
.github/pull_request_template.md [new file with mode: 0644]

diff --git a/.github/pull_request_template b/.github/pull_request_template
deleted file mode 100644 (file)
index caa96d4..0000000
+++ /dev/null
@@ -1,19 +0,0 @@
-**Package details**
-
-    Maintainer: @\<github-user> (find it by checking the history of the package Makefile)
-    Description:
-
-**Indication of run testing**
-
-     OpenWrt version:
-     OpenWrt target/subtarget:
-     OpenWrt device:
-
-**Formalities**
-
-     [ ] Review the [CONTRIBUTING.md](../CONTRIBUTING.md) file for detailed contributing guidelines.
-
-     If your PR contains a patch
-     [ ] Make sure that it can be applied by `git am`
-     [ ] It must be refreshed to avoid offsets, fuzzes, etc by `make package/foo/refresh V=s`
-     [ ] It must be in a way that it is potentially upstreamable (subject, commit description, etc.), and we must try to upstream it so we have fewer patches and fewer.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644 (file)
index 0000000..8d1d044
--- /dev/null
@@ -0,0 +1,32 @@
+## ๐Ÿ“ฆ Package Details
+
+**Maintainer:** @<github-user>
+<sub>(You can find this by checking the history of the package `Makefile`.)</sub>
+
+**Description:**
+<!-- Briefly describe what this package does or what changes are introduced -->
+
+---
+
+## ๐Ÿงช Run Testing Details
+
+- **OpenWrt Version:**
+- **OpenWrt Target/Subtarget:**
+- **OpenWrt Device:**
+
+---
+
+## โœ… Formalities
+
+- [ ] I have reviewed the [CONTRIBUTING.md](../CONTRIBUTING.md) file for detailed contributing guidelines.
+
+### If your PR contains a patch:
+
+- [ ] It can be applied using `git am`
+- [ ] It has been refreshed to avoid offsets, fuzzes, etc., using
+  ```bash
+  make package/<your-package>/refresh V=s
+  ```
+- [ ] It is structured in a way that it is potentially upstreamable
+<sub>(e.g., subject line, commit description, etc.)</sub>
+<sub>We must try to upstream patches to reduce maintenance burden.</sub>