[LTP] [PATCH 1/1] github: Improve pull request template

Petr Vorel pvorel@suse.cz
Tue Jan 10 09:47:24 CET 2023


* Signed-off-by
* code style
* links to wiki (API, maintainer checklist, ...)
* wrap text in html comments (instructions will not be visible)

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 .github/pull_request_template.md | 20 +++++++++++++++++---
 1 file changed, 17 insertions(+), 3 deletions(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 477f49c6bc..1082bcdd88 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,8 +1,22 @@
 [ type description here; PLEASE REMOVE THIS LINE AND THE LINES BELOW BEFORE SUBMITTING THIS PULL REQUEST ]
 
-Although we *occasionally* also accept GitHub pull requests, the *preferred* way is sending patches to our mailing list: https://lore.kernel.org/ltp/
-
+<!--
+* Although we *occasionally* also accept GitHub pull requests, the *preferred* way is sending patches to our mailing list: https://lore.kernel.org/ltp/
 There is an example how to use it: https://github.com/linux-test-project/ltp/wiki/C-Test-Case-Tutorial#7-submitting-the-test-for-review (using git format-patch and git send-email).
-
 LTP mailing list is archived at: https://lore.kernel.org/ltp/.
 We also have a patchwork instance: https://patchwork.ozlabs.org/project/ltp/list/.
+
+* Commits should be signed: Signed-off-by: Your Name <me@example.org>, see
+https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin
+
+* New code should follow Linux kernel coding style, see
+https://www.kernel.org/doc/html/latest/process/coding-style.html.
+You can run 'make check' or 'make check-foo' in the folder with modified code to check style and common errors.
+
+* For more tips check
+https://github.com/linux-test-project/ltp/wiki/Maintainer-Patch-Review-Checklist
+https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines
+https://github.com/linux-test-project/ltp/wiki/C-Test-API
+https://github.com/linux-test-project/ltp/wiki/Shell-Test-API
+https://github.com/linux-test-project/ltp/wiki/C-Test-Case-Tutorial
+-->
-- 
2.39.0



More information about the ltp mailing list