diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 15f59ac..db37a27 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,8 +6,7 @@ ## Running Tests -After cloning the repository the testing environment should be set up on the -local machine: +After cloning the repository the testing environment should be set up on the local machine: ``` $ bundle install --path vendor/bundle @@ -22,7 +21,17 @@ includes: * unit-tests (with `rspec-puppet`) * acceptance-tests (with `beaker-rspec`) +Check the .travis.yml for details. + ## Coding Standards -* All variables are defined in the base manifest (init.pp) -* No more than 140 characters per line +* 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. diff --git a/README.md b/README.md index f57d512..6b06d5e 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ ## Description -This module installs Limesurvey. +This module installs Limesurvey from the limesurvey.org website.. Optionally MySQL and Apache2 are installed and managed by this module. However, both classes can be overwritten. @@ -21,7 +21,7 @@ Optionally MySQL and Apache2 are installed and managed by this module. However, ### Beginning with limesurvey Basically this module downloads the code from limesurey.org and places it into the specified directory. -Without the database class included you need to install and manage the database by yourself. +Without the database class included you need to install and manage the database by yourself. Same for the websever and PHP. ## Usage @@ -56,7 +56,9 @@ For details on parameters see manifests This module has been tested on: * Debian 7, 8 -The CentOS Build needs fixing but the module should work. +Using Puppet >=4.5 + +The CentOS Build needs fixing, but the module should work. ## Development