From 48e2f63eab24d331fc4abb01c501ef5b59dee599 Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Wed, 31 Mar 2021 07:28:42 +0200 Subject: [PATCH] collection_checklist: improve (#161) * collection_checklist: improve * Fix * Fix a typo * add ref --- collection_checklist.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/collection_checklist.md b/collection_checklist.md index 31036d4..58a739d 100644 --- a/collection_checklist.md +++ b/collection_checklist.md @@ -17,12 +17,12 @@ Every comment should say whether the reviewer expects it to be addressed, or whe - [ ] follows 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) - [ ] follows [development conventions](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_best_practices.html) - [ ] supports Python 2.6 or greater and Python 3.5 or greater. If it does not, read the [full guidelines](https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst#python-compatibility) to see if you qualify for an exception and document the unsupported [Python versions](https://docs.ansible.com/ansible/latest/dev_guide/developing_python_3.html#ansible-and-python-3) in the collection ``README.md`` and in every module and plugin (or in doc fragments) -- [ ] Only uses recognized plugin types in the `plugins/` directory. +- [ ] only uses the [allowed plugin types](https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst#modules-plugins) in the `plugins/` directory - [ ] has `README.md` -- [ ] documentation, examples, and return use FQCNs for `M(..)`, examples, and `seealso` subsections -- [ ] modules (or plugins) from ansible-base use `ansible.builtin.` as a FQCN prefix +- [ ] documentation, examples, and return sections use FQCNs for the `M(..)` [format macros](https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_documenting.html#linking-and-other-format-macros-within-module-documentation) when referring to modules +- [ ] modules (or plugins) from ansible-core use `ansible.builtin.` as a FQCN prefix - [ ] documentation and return sections use `version_added:` containing the *collection* version for which an option, module or plugin was added -- [ ] FQCNs is used for `extends_documentation_fragment:`, unless you are referring to doc_fragments from ansible-base +- [ ] FQCNs are used for `extends_documentation_fragment:`, unless you are referring to doc_fragments from ansible-core **Collection management:** - [ ] `galaxy.yml` having `tags` field set