Contributing Guidelines

Contributions are welcome. Open a pull-request to this repository to submit your code change.

Bug Reports and Feature Requests

Please open an issue describing in detail the bug you observed or the feature you wish to see implemented. For bug reports, it helps to know versions of the following items:

• This project (supply a tag or revision)
• Ansible
• MacOS

Development and Testing

Unless otherwise specified, pull-requests will not be merged unless the CI build passes. For developing and testing this project on your system, follow the instructions below to get started.

1. Install VirtualBox (including the VirtualBox Extension Pack)
2. Install Vagrant
3. Install virtualenv: pip install -U virtualenv

If you already have Homebrew installed, you can use:

brew cask install virtualbox
brew cask install virtualbox-extension-pack
brew cask install vagrant

Now you can setup your virtual environment for testing:

virtualenv --python=$(which python2.7) .venv
source .venv/bin/activate
pip install --no-deps -r tests/test-requirements.txt

Run the full lifecycle test on a given <PLATFORM>. Allowed values for <PLATFORM> are mojave, highsierra, sierra, elcapitan, and yosemite.

source molecule/<PLATFORM>.sh
molecule test

Unset the MOLECULE_ environment variables:

source molecule/unset.sh

What if I just have a question?

For now, feel free to open an issue. I'll do my best to answer in a timely fashion.