Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

38 lines (25 loc) · 1.89 KB
Raw

Ansible Runner Contributing Guidelines

Hi there! We're excited to have you as a contributor.

If you have questions about this document or anything not covered here? Come chat with us #ansible-awx on irc.freenode.net

Things to know prior to submitting code

  • All code and doc submissions are done through pull requests against the devel branch.
  • Take care to make sure no merge commits are in the submission, and use git rebase vs git merge for this reason.
  • We ask all of our community members and contributors to adhere to the Ansible code of conduct. If you have questions, or need assistance, please reach out to our community team at codeofconduct@ansible.com

Setting up your development environment

Ansible Runner development is powered by Poetry, make sure you have it installed and then:

(host)$ poetry install

This will automatically setup the development environment under a virtualenv, which you can then switch to with:

(host)$ poetry shell

Linting and Unit Tests

tox is used to run linters (flake8 and yamllint) and unit tests on both Python 2 and 3. It uses poetry to bootstrap these two environments.

A note about setup.py

In this repository you will find a setup.py file, for the time being this needs to be kept in-sync by hand until Poetry. has the ability to generate a setup.py in a compatible way or the built-in Poetry tooling allows for the packaging/poetry-gen-setup.py to be sufficient for auto-generation. This is necessary as it allows the Ansible Runner codebase to be compatible with build and release systems that do not yet support Poetry.