Contributor Guide

To contribute to tox-ansible, 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/tox-ansible
$ cd tox-ansible
$ 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:

1. 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.

2. Before sending a PR, make sure that tox -e lint passes.

3. Architectural decisions (matrix semantics, config surfaces, plugin behavior) need an ADR under .sdlc/adrs/. See AGENTS.md and use /adr-new. To refresh the ansible-core matrices from the official lifecycle pages, use /update-matrix.

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

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

Talk to us

Code of Conduct

Please read and adhere to the Ansible Community Code of Conduct in all your interactions with the Ansible community.

Forum

Join the Ansible Forum as a single starting point and our 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!

• Get Help: get help or help others. Please add appropriate tags if you start new discussions, for example devtools.
• Posts tagged with 'devtools': subscribe to participate in project-related conversations.
• Bullhorn newsletter used to announce releases and important changes.
• Social Spaces: gather and interact with fellow enthusiasts.
• News & Announcements: track project-wide announcements including social events.

See Navigating the Ansible forum <https://forum.ansible.com/t/navigating-the-ansible-forum-tags-categories-and-concepts/39>_ for some practical advice on finding your way around.

Matrix

For real-time interactions, conversations in the community happen over the Matrix protocol in the #devtools:ansible.com.

For more information, see the community-hosted Matrix FAQ.