From 0564a2239fafa6a255e8a3ae5058986b5e7c48cb Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Fri, 6 Nov 2020 06:57:11 +0100 Subject: [PATCH] Clarify COLLECTIONS_PATH value when using clone (#1234) (#1235) (cherry picked from commit c85aa96177ffab6cd91e0fc8e52c74ed2b52ec51) Co-authored-by: Matthew Davis <7035647+mdavis-xyz@users.noreply.github.com> --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index af708eba81..a58ad792cc 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,14 @@ See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_gui If you want to develop new content for this collection or improve what is already here, the easiest way to work on the collection is to clone it into one of the configured [`COLLECTIONS_PATH`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths), and work on it there. +For example, if you are working in the `~/dev` directory: + +``` +cd ~/dev +git clone git@github.com:ansible-collections/community.general.git collections/ansible_collections/community/general +export COLLECTIONS_PATH=$(pwd)/collections:$COLLECTIONS_PATH +``` + You can find more information in the [developer guide for collections](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections), and in the [Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html). ### Running tests