From 5f7d8c5268d151c4ac9c29fcc15f0ca962f8b7b7 Mon Sep 17 00:00:00 2001 From: MKletz Date: Wed, 3 Aug 2022 11:03:33 -0500 Subject: [PATCH] Added contributing doc (#2) add contributing doc --- CONTRIBUTING.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ffa5141 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +# Contribution Guidelines +This document aims to outline the requirements for the various forms of contribution for this project. + +**ALL** contributions are subject to review via pull request + +## Pull requests +1) Ensure the "base repository" is set to "RedHatGov/product-demos" since this is a fork it defaults to it's parent "ansible/product-demos". + +## New playbooks +1) Create a new branch based on main +2) Add your playbook to the appropriate OS/System subdirectory +3) Make any changes needed to match the existing standards in the direcotory. + 1) Ex: Parameterized hosts + ```ansible + hosts: "{{ HOSTS | default('windows') }}" + ``` +4) Create an entry for your playbook in your subdirectories setup.yml + 1) You can copy paste an existing one and edit it. + 2) Ensure you edit the name, playbook path, survey etc. +5) Add any needed roles/collections to the [requirements.yml](/collections/requirements.yml) +6) Test via RHPDS, specify your branch name within the project configuration. + +## New OS/Systems +1) Create a new subdirectory with no spaces +2) Create a new setup.yml copying appropriate elements from another + 1) These should all be mostly the same at the top + ```ansible + --- + controller_components: + - job_templates + + controller_templates: + ... + ```