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

Commit

Permalink
collection_requirements: Fix formatting (#138)
Browse files Browse the repository at this point in the history
* Fix formatting

* Add a missed dot

* Improve formatting

* Add a note to summary
  • Loading branch information
Andersson007 authored Dec 11, 2020
1 parent 2ef2a01 commit 4f719ae
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions collection_requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ galaxy.yml
README.md
---------

MUST have a ``README.md`` in the root of the Collection, see `collection_template/README.md <https://github.com/ansible-collections/collection_template/blob/main/README.md>`_ for an example
MUST have a ``README.md`` in the root of the Collection, see `collection_template/README.md <https://github.com/ansible-collections/collection_template/blob/main/README.md>`_ for an example.

meta/runtime.yml
----------------
Expand Down Expand Up @@ -95,7 +95,7 @@ All module and plugin ``EXAMPLES`` MUST:
Other items:

* You MUST Use the FQCN for ``extends_documentation_fragment:``, unless you are referring to doc_fragments from ansible-base
* The ``CONTRIBUTING.md`` (or ``README.md``) file MUST state what types of contributions (PRs, feature requests,) are accepted and any relevant contributor guidance. Issues (bugs and feature request) reports must always be accepted
* The ``CONTRIBUTING.md`` (or ``README.md``) file MUST state what types of contributions (pull requests, feature requests, and so on) are accepted and any relevant contributor guidance. Issues (bugs and feature request) reports must always be accepted

Contributor Workflow
====================
Expand Down Expand Up @@ -149,7 +149,7 @@ We should avoid FQCN / repository names:
Licensing
=========

At the moment, module_utils must be licensed under the `BSD-2-clause <https://opensource.org/licenses/BSD-2-Clause>`_ or `GPL-3.0-or-later <https://www.gnu.org/licenses/gpl-3.0-standalone.html>`_ license and all other content must be licensed under the `GPL-3.0-or-later <https://www.gnu.org/licenses/gpl-3.0-standalone.html>`_. We will have a list of other open source licenses which are allowed as soon as we get Red Hat's legal team to approve such a list for us.
At the moment, ``module_utils`` must be licensed under the `BSD-2-clause <https://opensource.org/licenses/BSD-2-Clause>`_ or `GPL-3.0-or-later <https://www.gnu.org/licenses/gpl-3.0-standalone.html>`_ license and all other content must be licensed under the `GPL-3.0-or-later <https://www.gnu.org/licenses/gpl-3.0-standalone.html>`_. We will have a list of other open source licenses which are allowed as soon as we get Red Hat's legal team to approve such a list for us.


Repository management
Expand Down Expand Up @@ -228,7 +228,7 @@ To be included in the `ansible` package, collections must meet the following cri
* `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>`_
* 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>`_ according to the corresponding sections of this document


Other things
Expand Down

0 comments on commit 4f719ae

Please sign in to comment.