WMDE
/
puppet-limesurvey
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README and CONTRIBUTING

This commit is contained in:
Markus Opolka 2016-09-08 13:37:18 +02:00
parent c4c8c7c174
commit f76c73db5b
2 changed files with 18 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@ -6,8 +6,7 @@
## Running Tests ## Running Tests
After cloning the repository the testing environment should be set up on the After cloning the repository the testing environment should be set up on the local machine:
local machine:
``` ```
$ bundle install --path vendor/bundle $ bundle install --path vendor/bundle
@ -22,7 +21,17 @@ includes:
* unit-tests (with `rspec-puppet`) * unit-tests (with `rspec-puppet`)
* acceptance-tests (with `beaker-rspec`) * acceptance-tests (with `beaker-rspec`)
Check the .travis.yml for details.
## Coding Standards ## Coding Standards
* All variables are defined in the base manifest (init.pp) * All variables are defined in the base manifest (init.pp).
* No more than 140 characters per line * 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.

8
README.md
View File

@ -12,7 +12,7 @@
## Description ## 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. 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 ### Beginning with limesurvey
Basically this module downloads the code from limesurey.org and places it into the specified directory. 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 ## Usage
@ -56,7 +56,9 @@ For details on parameters see manifests
This module has been tested on: This module has been tested on:
* Debian 7, 8 * 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 ## Development