From 079dbffe51a5e75b3f7a4fbb14eb3f3a0ec950d3 Mon Sep 17 00:00:00 2001 From: Alex Willmer Date: Sun, 7 Feb 2021 14:34:28 +0000 Subject: [PATCH] WIP --- .github/PULL_REQUEST_TEMPLATE.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 116b0c79..ac7729d3 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,16 +1,19 @@ Thanks for creating a PR! Here's a quick checklist to pay attention to: -* Please add an entry to docs/changelog.rst as appropriate. +* [ ] Add an entry to `docs/changelog.rst` as appropriate. + E.g. + ```rst + - :gh:issue:1234 Fix leaky drain pipe + ``` + Some changes don't need a change log entry (e.g. CI fixes), but if in doubt please include one. -* Has some new parameter been added or semantics modified somehow? Please - ensure relevant documentation is updated in docs/ansible.rst and - docs/api.rst. +* [ ] Update relevant documention if introducing new features, or a change to semantics. + E.g. has a parameter has been added, or semantics modified somehow? Please ensure relevant documentation is updated in `docs/ansible.rst`, and `docs/api.rst`. -* If it's for new functionality, is there at least a basic test in either - tests/ or tests/ansible/ covering it? +* [ ] For a bug fix or new functionality, please include at least a basic test. + For pure mitogen this will be in `tests/*.py`, for ansible_mitogen it will be in `tests/ansible/`? -* If it's for a new connection method, please try to stub out the - implementation as in tests/data/stubs/, so that construction can be tested - without having a working configuration. +* [ ] For a new connection method, please try to stub out the implementation as in `tests/data/stubs/`. + This is so that construction can be tested without having a working configuration.