Contributing

  • We are interested in various different kinds of improvement for Molecule; please feel free to raise an Issue if you would like to work on something major to ensure efficient collaboration and avoid duplicate effort.
  • Create a topic branch from where you want to base your work.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Make sure you have added tests for your changes.
  • Run all the tests to ensure nothing else was accidentally broken.
  • Reformat the code by following the formatting section below.
  • Submit a pull request.

Installing from source

Due to the rapid pace of development on this tool, you might want to install it in “development” mode so that new updates can be obtained by simply doing a git pull in the repository’s directory.

$ cd /path/to/repos
$ git clone git@github.com:metacloud/molecule.git
$ cd molecule
$ sudo python setup.py develop

There is also a pip pattern for development mode:

$ cd /path/to/repos
$ git clone git@github.com:metacloud/molecule.git
$ pip install -U -e .

Testing

Perform all of the Full testing steps prior to submitting a PR.

Ansible Modules

This project uses the following Ansible modules, and Gilt to manage them.

To bring in updated upstream modules. Update gilt.yml and execute the following:

$ gilt overlay