Contribution Guide Update

[jon-nfc]

To aid in contributions, document CONTRIBUTING.md exists as a one stop shop for contributing to the repo. This document has not been fluffed to ensure it's useful.

Details

Update the contribution guide. This is a must as this is the documents purpose.

Links

• #34 (Inventory Upload): Add output to determine inventory upload failure #35

---

Below this line is the interim contribution guide until such time the guide has been updated within the repository.

---

Interim CONTRIBUTING.md document

This document is to be read in conjunction with CONTRIBUTING.md.

First and foremost, thank you for your contribution. If at any stage you are stuck, confused or any other developer prone state, please ask for help.

Requirements

• Commit Messages use conventional commit format

• ALL CI jobs must pass. if they error, you can view the "details" for what went wrong.

• Ansible:

  • Tasks must be named
  • Task name must reflect their activity
  • All task modules to use FQCN
  • Don't be afraid of white space.
    • Two blanks lines above tasks
    • Two blank lines blow tasks
    • One blank line at the end of the file
  • Any task that "spills" a secret, must use no_log