Skip to content

Latest commit

 

History

History
36 lines (21 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

36 lines (21 loc) · 1.32 KB

Contributing

We love pull requests from everyone. By participating in this project, you agree to abide by the code of conduct.

Fork, then clone the repo:

git clone git@github.com:your-username/3D-e-Chem-VM.git

Set up your machine:

pip install ansible

And install packer see https://www.packer.io/downloads.html for instructions.

Make sure the syntax checks pass:

ansible-playbook -i localhost, --syntax-check playbook.yml
packer validate -syntax-only packer.json

Make your change. Make the syntax checks pass:

ansible-playbook -i localhost, --syntax-check playbook.yml
packer validate -syntax-only packer.json

Optionally test the change works by building a Vagrant box and testing it manually as explained in README.md#Build and README.md#Test chapters respectively.

Push to your fork and submit a pull request.

At this point you're waiting on us. We like to at least comment on pull requests within three business days (and, typically, one business day). We may suggest some changes or improvements or alternatives.

Some things that will increase the chance that your pull request is accepted: