CONTRIBUTING.md

Contributing to Drifter

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to Drifter, which is hosted on GitHub : https://github.com/liip/drifter. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

How Can I Contribute?

Reporting Bugs

• Provide a list of steps to reproduce the issue
• Which version of Drifter are you using ?
• What is your OS ? Vagrant version ?
• If possible, a link to your project
• Post the content of your playbook.yml and paramters.yml files
• Check the existing issues / PR to see if your issue is already being worked on
• Check the Changelog to see if a fix is awaiting a release

Suggesting Enhancements

• Check the https://github.com/liip/drifter/tree/master/provisioning/roles directory, not all roles are listing in playbook.yml
• Does the feature will be useful for multiple people or just your project ?
• Check the existing issues / PR to see if something similar is already being proposed.
• Check the Changelog to see if it's not already implemented

Pull Requests

• Try to make your commits atomic.
• One feature per PR.

Coding Style

• Respect the indentation style.
• End files with a newline.
• Too much comments are better than not enough.