Skip to content
This repository has been archived by the owner on May 28, 2024. It is now read-only.

Commit

Permalink
collection_checklist: improve (#161)
Browse files Browse the repository at this point in the history
* collection_checklist: improve

* Fix

* Fix a typo

* add ref
  • Loading branch information
Andersson007 authored Mar 31, 2021
1 parent 8686fa7 commit 48e2f63
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions collection_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 48e2f63

Please sign in to comment.