Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Getting in touch

Join the Ansible Forum, the default communication platform for questions and help, development discussions, events, and much more. Register to join the community. Search by categories and tags to find interesting topics or start a new one; subscribe only to topics you need!

See Navigating the Ansible forum for some practical advice on finding your way around.

Types of Contributions

You can contribute in many ways:

Report Bugs

Report bugs at https://github.com/ansible/ansible-rulebook/issues.

If you are reporting a bug, please include:

  • Your operating system name and the output of ansible-rulebook --version

  • Any details about your local setup that might be helpful in troubleshooting.

  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

ansible-rulebook could always use more documentation, whether as part of the official ansible-rulebook docs, in docstrings, or even on the web in blog posts, articles, and such.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.

  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.

  3. The pull request should work for Python 3.9

  4. Commit messages must conform to conventional commit

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/ansible/ansible-rulebook/issues.

If you are proposing a feature:

  • Explain in detail how it would work.

  • Keep the scope as narrow as possible, to make it easier to implement.

  • Remember that this is a volunteer-driven project, and that contributions are welcome :)