This commit is contained in:
Alex Willmer 2021-02-07 14:34:28 +00:00
parent 9546bd7328
commit 079dbffe51
1 changed files with 12 additions and 9 deletions

View File

@ -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.