fix spacing to fix header, reorg contributing page (#74421)
Co-authored-by: John R Barker <john@johnrbarker.com>
This commit is contained in:
parent
f97787ca74
commit
9d9b08bece
1 changed files with 26 additions and 5 deletions
|
@ -6,25 +6,46 @@ Contributing to collections
|
||||||
|
|
||||||
If you want to add functionality to an existing collection, modify a collection you are using to fix a bug, or change the behavior of a module in a collection, clone the git repository for that collection and make changes on a branch. You can combine changes to a collection with a local checkout of Ansible (``source hacking/env-setup``).
|
If you want to add functionality to an existing collection, modify a collection you are using to fix a bug, or change the behavior of a module in a collection, clone the git repository for that collection and make changes on a branch. You can combine changes to a collection with a local checkout of Ansible (``source hacking/env-setup``).
|
||||||
You should first check the collection repository to see if it has specific contribution guidelines. These are typically listed in the README.md or CONTRIBUTING.md files within the repository.
|
You should first check the collection repository to see if it has specific contribution guidelines. These are typically listed in the README.md or CONTRIBUTING.md files within the repository.
|
||||||
|
|
||||||
Contributing to a collection: community.general
|
Contributing to a collection: community.general
|
||||||
===============================================
|
===============================================
|
||||||
|
|
||||||
This section describes the process for `community.general <https://github.com/ansible-collections/community.general/>`_. To contribute to other collections, replace the folder names ``community`` and ``general`` with the namespace and collection name of a different collection.
|
These instructions apply to collections hosted in the `ansible_collections GitHub org <https://github.com/ansible-collections>`_. For other collections, especially for collections not hosted on GitHub, check the ``README.md`` of the collection for information on contributing to it.
|
||||||
|
|
||||||
We assume that you have included ``~/dev/ansible/collections/`` in :ref:`COLLECTIONS_PATHS`, and if that path mentions multiple directories, that you made sure that no other directory earlier in the search path contains a copy of ``community.general``. Create the directory ``~/dev/ansible/collections/ansible_collections/community``, and in it clone `the community.general Git repository <https://github.com/ansible-collections/community.general/>`_ or a fork of it into the folder ``general``::
|
This example uses the `community.general collection <https://github.com/ansible-collections/community.general/>`_. To contribute to other collections in the same GitHub org, replace the folder names ``community`` and ``general`` with the namespace and collection name of a different collection.
|
||||||
|
|
||||||
|
Prerequisites
|
||||||
|
-------------
|
||||||
|
|
||||||
|
* Include ``~/dev/ansible/collections/`` in :ref:`COLLECTIONS_PATHS`
|
||||||
|
* If that path mentions multiple directories, make sure that no other directory earlier in the search path contains a copy of ``community.general``.
|
||||||
|
|
||||||
|
Creating a PR
|
||||||
|
-------------
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
* Create the directory ``~/dev/ansible/collections/ansible_collections/community``::
|
||||||
|
|
||||||
mkdir -p ~/dev/ansible/collections/ansible_collections/community
|
mkdir -p ~/dev/ansible/collections/ansible_collections/community
|
||||||
|
|
||||||
|
* Clone `the community.general Git repository <https://github.com/ansible-collections/community.general/>`_ or a fork of it into the directory ``general``::
|
||||||
|
|
||||||
cd ~/dev/ansible/collections/ansible_collections/community
|
cd ~/dev/ansible/collections/ansible_collections/community
|
||||||
git clone git@github.com:ansible-collections/community.general.git general
|
git clone git@github.com:ansible-collections/community.general.git general
|
||||||
|
|
||||||
If you clone a fork, add the original repository as a remote ``upstream``::
|
* If you clone from a fork, add the original repository as a remote ``upstream``::
|
||||||
|
|
||||||
cd ~/dev/ansible/collections/ansible_collections/community/general
|
cd ~/dev/ansible/collections/ansible_collections/community/general
|
||||||
git remote add upstream git@github.com:ansible-collections/community.general.git
|
git remote add upstream git@github.com:ansible-collections/community.general.git
|
||||||
|
|
||||||
Now you can use this checkout of ``community.general`` in playbooks and roles with whichever version of Ansible you have installed locally, including a local checkout of ``ansible/ansible``'s ``devel`` branch.
|
* Create a branch and commit your changes on the branch.
|
||||||
|
|
||||||
For collections hosted in the ``ansible_collections`` GitHub org, create a branch and commit your changes on the branch. When you are done (remember to add tests, see :ref:`testing_collections`), push your changes to your fork of the collection and create a Pull Request. For other collections, especially for collections not hosted on GitHub, check the ``README.md`` of the collection for information on contributing to it.
|
* Remember to add tests for your changes, see :ref:`testing_collections`.
|
||||||
|
|
||||||
|
* Push your changes to your fork of the collection and create a Pull Request.
|
||||||
|
|
||||||
|
You can test your changes by using this checkout of ``community.general`` in playbooks and roles with whichever version of Ansible you have installed locally, including a local checkout of ``ansible/ansible``'s ``devel`` branch.
|
||||||
|
|
||||||
.. seealso::
|
.. seealso::
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue