Contributions

This document describes the process that should be followed to make official contributions to the main branch.

---

ALL contributions to the chefboyrd module should be made through pull requests. This means that all features must be housed on feature branches. You should NOT be making commits directly to the master branch.

To create a new branch you can run the command

git branch branch_name

After creating the new branch you can make whatever commits are necessary to create the features you want. If you are using branches on the main repository, travis-ci will pick them up and run unit tests for you.

Once you want to push your changes into master, Go in to github and go to pull requests and click create new. Choose the branches accordingly and create the pull request.

GitHub will then pull your code onto the current master branch and run the tests through travis. If all is well then you should see a message on the pull request noting that all tests have passed. Otherwise you'll need to go back into your branch and make commits to fix the issue.

Once all tests are passing and your code is satisfactory (up to your own standards), then the pull request can be merged into master.