puppet-limesurvey/CONTRIBUTING.md

38 lines
883 B
Markdown
Raw Normal View History

2016-09-08 10:59:56 +00:00
# Testing
## Prerequisites
`Docker` and `ruby` need to be installed on the local machine.
## Running Tests
2016-09-08 11:37:18 +00:00
After cloning the repository the testing environment should be set up on the local machine:
2016-09-08 10:59:56 +00:00
```
$ bundle install --path vendor/bundle
$ bundle exec rake
```
With running `rake` the whole testsuite is triggered, this
includes:
* puppet syntax validation
* code-style enforcement (with `puppet-lint`)
* unit-tests (with `rspec-puppet`)
* acceptance-tests (with `beaker-rspec`)
2016-09-08 11:37:18 +00:00
Check the .travis.yml for details.
2016-09-08 10:59:56 +00:00
## Coding Standards
2016-09-08 11:37:18 +00:00
* All variables are defined in the base manifest (init.pp).
* No more than 140 characters per line.
## Commits
* Fork it, Branch it, Test it, Pull Request it, Technologic.
* Logical commit units.
* Nice clean commit messages.
* Check for whitespaces. I hate whitespaces.
* New Features equals new tests and new documentation.