aboutsummaryrefslogtreecommitdiff
path: root/.github/pull_request_template.md
diff options
context:
space:
mode:
authorLinus Jahn <lnj@kaidan.im>2022-05-22 19:31:43 +0200
committerLinus Jahn <lnj@kaidan.im>2022-05-22 19:31:43 +0200
commit9e96ab61349e313bf91035b3872a89510bfeee2f (patch)
treeb6c631317c3b96232fddc93d868eb2b2120e0dda /.github/pull_request_template.md
parentca5065c2c9b10250d8728517cc2b48e638831eaf (diff)
pr template: Simplify check list
Diffstat (limited to '.github/pull_request_template.md')
-rw-r--r--.github/pull_request_template.md20
1 files changed, 12 insertions, 8 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 1565e426..00d9694f 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,8 +1,12 @@
-Before opening a pull-request please do:
-- [ ] Documentation:
- - [ ] Document every new public class and function
- - [ ] Add `\since QXmpp 1.X` to newly added classes and functions
- - [ ] Fix any doxygen warnings from your code (see log when building with `-DBUILD_DOCUMENTATION=ON`)
-- [ ] When implementing or updating XEPs add it to `doc/xep.doc`
-- [ ] Add unit tests for everything you've changed or added
-- [ ] On the top level, run `clang-format -i src/<edited-file(s)> tests/<edited-file(s)>`
+PR check list:
+- [ ] Document your code
+- [ ] Add `\since QXmpp 1.X`
+- [ ] Fix doxygen warnings (see log when building with `-DBUILD_DOCUMENTATION=ON`)
+- [ ] Update `doc/xep.doc`
+- [ ] Add unit tests
+- [ ] Format the code: Run `clang-format -i src/<edited-file(s)> tests/<edited-file(s)>`
+
+<!--
+Points should be checked when they're done. They should also be checked when no
+changes were required.
+-->