Contributor Guide¶

To contribute to ansible-dev-tools python package or to the list of tools part of it, please use pull requests on a branch of your own fork.

After creating your fork on GitHub, you can do:

$ git clone --recursive git@github.com:your-name/developer-tool-name
$ cd developer-tool-name
$ git checkout -b your-branch-name
# DO SOME CODING HERE
$ git add your new files
$ git commit -v
$ git push origin your-branch-name

You will then be able to create a pull request from your commit.

Prerequisites:

All fixes to core functionality (i.e. anything except docs or examples) should be accompanied by tests that fail prior to your change and succeed afterwards.
Before sending a PR, make sure that tox -e lint passes.

Feel free to raise issues in the repo if you feel unable to contribute a code fix.

Talk to us¶

Use Github discussions forum or for a live chat experience try #ansible-devtools IRC channel on libera.chat or Matrix room #devtools:ansible.com.

For the full list of Ansible IRC and Mailing list, please see the Ansible Communication page. Release announcements will be made to the Ansible Announce list.

Possible security bugs should be reported via email to security@ansible.com.

Code of Conduct¶

Please see the official Ansible Community Code of Conduct.