Before starting your work on this module, you should fork the project to your GitHub account. This allows you to freely experiment with your changes. When your changes are complete, submit a pull request. All pull requests will be reviewed and merged if they suit some general guidelines:
- Changes are located in a topic branch
- For new functionality, proper tests are written
- Changes should not solve certain problems on special environments
- Your change does not handle third party software for which dedicated Ansible role exist, such as creating databases, installing webserver etc.
Only use devel branch for your pull requests, as the master/main branch should only contain working, tagged releases.
Furthermore, please take care to maintain the existing coding style.
Choosing a proper name for a branch helps us identify its purpose and possibly find an associated bug or feature.
Generally a branch name should include a topic such as fix or feature followed by a description and an issue number
if applicable. Branches should have only changes relevant to a specific issue.
git checkout -b fix/service-template-typo-1234
git checkout -b feature/config-handling-1235If you add new functionality, make sure to write appropriate tests as well. A complete guide on how to run tests is described in TESTING.md.