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

Commit

Permalink
Add the section to the checklist: List of requirements for collection…
Browse files Browse the repository at this point in the history
…s to be included in Ansible (#129)

* Add List of requirements for collections to be included in Ansible

* collection_requirements, public bug tracker

* Remove bug tracker and PR acceptance for a while

* Update collection_requirements.rst

Co-authored-by: John R Barker <[email protected]>

* Update collection_requirements.rst

Co-authored-by: John R Barker <[email protected]>

* Update collection_requirements.rst

Co-authored-by: Deric Crago <[email protected]>

Co-authored-by: John R Barker <[email protected]>
Co-authored-by: Deric Crago <[email protected]>
  • Loading branch information
3 people authored Dec 3, 2020
1 parent fa1172f commit 85371e7
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions collection_requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,18 @@ Also:
See `Migrating content to a different collection <https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#migrating-ansible-content-to-a-different-collection>`_ for complete details.


Requirements for collections to be included in the Ansible Package
==================================================================

To be included in the `ansible` package, collections must meet the following criteria:

* `development conventions <https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_best_practices.html>`_
* `Collection requirements <https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst>`_ (this document)
* `Ansible documentation format <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>`_
* to pass the Ansible `sanity tests <https://docs.ansible.com/ansible/devel/dev_guide/testing_sanity.html#testing-sanity>`_
* to have `unit <https://docs.ansible.com/ansible/devel/dev_guide/testing_units.html#unit-tests>`_ and / or `integration tests <https://docs.ansible.com/ansible/devel/dev_guide/testing_integration.html#integration-tests>`_


Other things
============

Expand Down

0 comments on commit 85371e7

Please sign in to comment.