CONTRIBUTING.md

Contribution guidelines

Table of contents

• Contribution guidelines
  • Contributing
  • Coding guidelines
    • Zabbix roles
    • Zabbix modules
  • Testing and Development
    • Testing Zabbix roles
    • Testing Zabbix modules
• Additional information
  • Virtualenv
  • Links

Thank you very much for taking time to improve this Ansible collection. We appreciate your every contribution. Please make sure you are familiar with the content presented in this document to avoid any delays during reviews or merge.

Please note that this project is released with following codes of conduct and by participating in the project you agree to abide by them:

• Contributor Covenant Code of Conduct
• Community Code of Conduct

If you are interested in joining us as a maintainer, please open an issue.

Contributing

1. Fork this repository
2. Create a new branch and apply your changes to it. In addition to that:
   1. Ensure that any changes you introduce to this collection are reflected in the documentation.
   2. Ensure that your PR contains valid changelog fragment.
   3. Include tests with your contribution to ensure that future pull requests will not break your functionality.
   4. Make sure that tests succeed.
3. Push the branch to your forked repository.
4. Submit a new pull request into this collection.

Notes:

• Pull requests that fail during the tests will not be merged. If you have trouble narrowing down cause of a failure and would like some help, do not hesitate to ask for it in comments.
• If you plan to propose an extensive feature or breaking change, please open an issue first. This allows collection maintainers to comment on such change in advance and avoid possible rejection of such contribution.

Coding guidelines

Style guides are important because they ensure consistency in the content, look, and feel of a book or a website. Any contributions to this collection must adhere to the following rules:

• Ansible style guide.
• Use "Ansible" when referring to the product and ansible when referring to the command line tool, package and so on.

Roles

• Playbooks should be written in multi-line YAML format using key: value.
  • The form key=value is suitable for ansible ad-hoc execution, not for ansible-playbook.
• Every task should always have a name: keyword associated with it.

Testing and Development

2DO

Additional information

Virtualenv

It is recommended to use virtualenv for development and testing work to prevent any conflicting dependencies with other projects.

A few resources describing virtualenvs:

• http://thepythonguru.com/python-virtualenv-guide/
• https://realpython.com/python-virtual-environments-a-primer/
• https://www.dabapps.com/blog/introduction-to-pip-and-virtualenv-python/

Links

• Ansible
• Ansible style guide
• Ansible module best practices
• Integration testing with ansible-test
• Docker installation guide
• Molecule
• Molecule V2 with your own role
• dj-wasabi/ansible-ci-base
• Current Zabbix releases

End note: Have fun making changes. If a feature helps you, others may find it useful as well and we will be happy to merge it.