github: Improve pull request template

* Signed-off-by * code style * links to wiki (API, maintainer checklist, ...) * wrap text in html comments (instructions will not be visible) Reviewed-by: Richard Palethorpe <[email protected]> Reviewed-by: Avinesh Kumar <[email protected]> Signed-off-by: Petr Vorel <[email protected]>
linux-test-project · Jan 10, 2023 · d9a6d8d · d9a6d8d
1 parent 4d99247
commit d9a6d8d
Showing 1 changed file with 22 additions and 3 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,8 +1,27 @@
 [ 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 <[email protected]>, see
+https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin
+
+* Commit message should be meaningful, following common style
+https://www.kernel.org/doc/html/latest/process/submitting-patches.html#split-changes
+https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes
+https://cbea.ms/git-commit/
+
+* 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
+-->