This library has grown over time based on a range of contributions from people using it. If you follow these contributing guidelines your patch will likely make it into a release a little quicker.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Contributor Code of Conduct.
-
Fork the repo.
-
Create a separate branch for your change.
-
Run the tests. We only take pull requests with passing tests, and documentation.
-
Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, please add a test.
-
Squash your commits down into logical components. Make sure to rebase against the current master.
-
Push the branch to your fork and submit a pull request.
Please be prepared to repeat some of these steps as our contributors review your code.
The testing and development tools have a bunch of dependencies, all managed by bundler according to the Puppet support matrix.
Install the dependencies like so...
bundle install
The unit test suite covers most of the code, as mentioned above please add tests if you're adding new functionality.
To run your all the unit tests
bundle exec rspec spec
To run a specific spec test
bundle exec rspec spec/foo_spec.rb