From 5baf2e04efff15abc0896075bc1e07b970deb0d8 Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Mon, 22 Mar 2021 10:29:47 +0100 Subject: [PATCH] Add review_checklist.md --- review_checklist.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 review_checklist.md diff --git a/review_checklist.md b/review_checklist.md new file mode 100644 index 0000000..6da0deb --- /dev/null +++ b/review_checklist.md @@ -0,0 +1,27 @@ +# Review Checklist + +When reviewing, keep in mind that we follow [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) in all our contributions and interactions within this repository. + +If your suggestion in a review comment is optional or a matter of personal preferences, please say it. + +**Standards and documentation** +- [ ] the pull request is not a documentation fix, it must include a [changelog fragment](https://docs.ansible.com/ansible/devel/community/development_process.html#creating-a-changelog-fragment). Please check the format carefully +- [ ] if new files are added with the pull request, they follow the [licensing rules](https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst#licensing) +- [ ] the changes follow the [Ansible documentation standards](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html) and the [style guide](https://docs.ansible.com/ansible/devel/dev_guide/style_guide/index.html#style-guide) +- [ ] follow [development conventions](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_best_practices.html) +- [ ] if a new plugin is added, it is one of the [allowed plugin types](https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst#id14) +- [ ] documentation, examples, and return use FQCNs for `M(..)`, examples, and `seealso` subsections +- [ ] modules (or plugins) from ansible-core use `ansible.builtin.` as a FQCN prefix +- [ ] when a new option, module, plugin, or return value is added, the corresponding documentation or return sections use `version_added:` containing the *collection* version for which they were added +- [ ] FQCNs is used for `extends_documentation_fragment:`, unless the author is referring to doc_fragments from ansible-base + +**Tests (if applicable and possible to implement):** +- [ ] the pull request has integration tests +- [ ] the pull request has unit tests +- [ ] all changes are covered +- [ ] integration tests also cover `check_mode` +- [ ] integration tests check an actual state of the system, not only what the module reports (for example, if the module change a file, check that the file was actually changed by using the `ansible.builtin.stat` module) + +**Other** +- [ ] the pull request does not contain merge commits (see GitHub warnings at the bottom of the pull request) +- [ ] if the pull request contains breaking changes, ask the author if it is really needed and there is no way not to introduce them