Skip to content
Bert Van Vreckem edited this page Nov 3, 2015 · 3 revisions

Thank you for considering to contribute to one of my Ansible roles. Please remark that the guidelines below are completely optional. Every contribution that adds value is gratefully accepted, regardless of the coding style. If necessary, I will update the code myself to be in line with the style that I use.

However, you will the process of merging your contribution considerably easier.

  • One pull request per feature/fix. Avoid pull requests that fix multiple issues or add multiple features.

  • Document all role variables. If you add role variables, please add them to the documentation in the README.md

  • Add a test. Update the test playbook to include any variables that you introduced, so the contribution can be validated.

  • Update the change log. Describe your contribution in the change log. You can add a header above the one for the latest release without filling in the version number and release date, e.g.:

    ## Version X.Y.Z - YYYY-MM-DD
    ### Added
    - Implemented foo (GH-NN) (Credit [@USERNAME](https://github.com/USERNAME))

    If an issue number is associated with the feature/fix contributed, refer to it in the desciption with (GH-NN) (NN being the issue number). Give yourself credit!

  • Add your name to the contributor list in the README. Under the header "Author information", add your name and/or Github handle and link to your Github page, e.g.

    Contributions by:
    - The Octocat ([@octocat](https://github.com/octocat))
Clone this wiki locally