Contributing

Contributors to the collection should take their time to read these guidelines, in order to avoid certain common pitfalls and needless frustration during code review.

These guidelines may change, depending on evolution of the project. However, all changes should be perfomed with consideration for other developers workflow and for projects using edpm-ansible collection.

General recommendation

Test your code locally, if it is at all possible, to shorten the development loop and minimize unnecessary use of CI. Before commiting your changes, run pre-commit check to avoid needless issues with style, such as indentation.

Note

Pre-commit hooks should be installed in your local repo with: pre-commit install Alternatively, you can run all hooks on all files with: pre-commit run -a

• Contributing Roles
  • Role design principles
    • Variables
    • Conditionals
    • Tasks
    • Error handling
    • Privilege escalation
  • Role test development
  • Documenting a new role
  • Create a new role
• Contributing plugins
  • Plugin structure
  • Check mode
  • Plugin testing
• Contributing Playbooks
  • Playbook design principles
    • Error handling
  • Playbook test development
  • Documenting a new playbook
  • Create a new playbook
• Testing roles
  • Testing roles with molecule
  • Creating a VM to run molecule
  • Writing molecule tests
• Testing with ansibleee
  • Provide NFS access to your edpm-ansible directory
  • Create edpm-ansible PV and PVC
  • Add extraMount to your OpenStackDataPlaneNodeSet CR