Expand checklist and clarify requirements (#196)

* Expand checklist and clarify requirements * Update collection_checklist.md Co-authored-by: John R Barker <[email protected]> * Update collection_checklist.md Co-authored-by: John R Barker <[email protected]> * Update collection_checklist.md Co-authored-by: John R Barker <[email protected]>
ansible-collections · Feb 16, 2022 · bbec2b1 · bbec2b1
1 parent 3cfd794
commit bbec2b1
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/collection_checklist.md b/collection_checklist.md
@@ -33,8 +33,11 @@ Every comment should say whether the reviewer expects it to be addressed, or whe
 - [ ] collection dependencies must have a lower bound on the version which is at least 1.0.0, and are all part of the `ansible` package
 - [ ] `meta/runtime.yml` defines the minimal version of Ansible which the collection works with
 - [ ] has changelog, preferably with `changelogs/changelog.yaml`
+- [ ] collection repository should not contain any large objects (binaries) comparatively to the current Galaxy tarball size limit of 20 MB. For example, package installers for testing purposes shouldn't be added.
+- [ ] collection repository should not contain any unnecessary files like, for example, temporary files created by development tools. Temporary files MUST be added to `.gitignore`.
 
 **Tests:**
+
 - [ ] passed `ansible-test sanity`
 - [ ] if `test/sanity/ignore*.txt` exists, it does not contain error codes listed [here](https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst#ci-testing)
 - [ ] has CI tests up and running against each of the "major versions" of `ansible-base`/`ansible-core` that the collection supports

diff --git a/collection_requirements.rst b/collection_requirements.rst
@@ -47,6 +47,9 @@ Collections
   * The CoC MUST be linked from the ``README.md`` file, or MUST be present or linked from the ``CODE_OF_CONDUCT.md`` file in the collection root.
 
 * MUST be published to `Ansible Galaxy <https://galaxy.ansible.com>`_.
+* SHOULD NOT contain any large objects (binaries) comparatively to the current Galaxy tarball size limit of 20 MB like, for example, package installers for testing purposes.
+* SHOULD NOT contain any unnecessary files like, for example, temporary files created by development tools.
+* MUST only contain objects that follow the :ref:`licensing rules<Licensing>`.
 
 Python Compatibility
 ====================
@@ -233,6 +236,8 @@ Module naming
 Modules that only gather information MUST be named ``<something>_info``. Modules that return ``ansible_facts`` are named ``<something>_facts`` and do not return non-facts.
 For more information, refer to the `Developing modules guidelines <https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_general.html#creating-an-info-or-a-facts-module>`_.
 
+.. _Licensing:
+
 Licensing
 =========