Add some contibuting docs

Diabol · Jun 9, 2013 · 365f142 · 365f142
1 parent b1f6aa1
commit 365f142
Show file tree

Hide file tree

Showing 18 changed files with 53 additions and 30 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,7 +1,5 @@
+script: ./script/cibuild
 rvm: 1.8.7
-branches:
-  only:
-    - master
 notifications:
   email:
     - [email protected]

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,28 @@
+Thanks for contributing to puppet-logrotate! A couple of notes to help you out:
+
+ * Please don't bump the module version number.
+ * Make sure your changes have tests.
+ * Keep your pull requests on topic. Pull requests with a bunch of unrelated
+   changes won't get merged. Feel free to open seperate pull requests for the
+   other changes though.
+ * Yes, I commit vendored gem files into my repositories. No, this is not
+   a mistake. Please don't "fix" this in your pull request :)
+
+Before starting, you can prepare your development environment by running:
+
+```
+script/bootstap
+```
+
+This will install all the dependencies required to run the test suite.
+
+Although TravisCI will automatically run the test suite against your branch
+when you push, you can (and should) run them locally as you're working. You can
+run the test suite by running:
+
+```
+script/cibuild
+```
+
+This will run all the rspec-puppet tests followed by puppet-lint to catch any
+style issues.
diff --git a/Gemfile b/Gemfile
@@ -2,7 +2,6 @@ source 'https://rubygems.org'
 
 puppetversion = ENV.key?('PUPPET_VERSION') ? "= #{ENV['PUPPET_VERSION']}" : ['>= 3.2']
 
-gem 'rake'
 gem 'puppet-lint'
 gem 'rspec-puppet'
 gem 'puppetlabs_spec_helper'

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -2,21 +2,25 @@ GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.2.4)
-    facter (1.6.18)
-    hiera (1.0.0)
+    facter (1.7.1)
+    hiera (1.2.1)
+      json_pure
+    json_pure (1.8.0)
     metaclass (0.0.1)
     mocha (0.14.0)
       metaclass (~> 0.0.1)
-    puppet (3.0.2)
-      facter (~> 1.6.11)
-      hiera (~> 1.0.0)
+    puppet (3.2.1)
+      facter (~> 1.6)
+      hiera (~> 1.0)
+      rgen (~> 0.6)
     puppet-lint (0.3.2)
     puppetlabs_spec_helper (0.4.1)
       mocha (>= 0.10.5)
       rake
       rspec (>= 2.9.0)
       rspec-puppet (>= 0.1.1)
-    rake (0.9.2.2)
+    rake (10.0.4)
+    rgen (0.6.2)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)
       rspec-expectations (~> 2.13.0)
@@ -32,8 +36,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  puppet (= 3.0.2)
+  puppet (>= 3.2)
   puppet-lint
   puppetlabs_spec_helper
-  rake
   rspec-puppet
diff --git a/README.md b/README.md
@@ -88,7 +88,7 @@ lastaction      - A command String that should be execute by /bin/sh once
 rotate          - The Integer number of rotated log files to keep on disk
                   (optional).
 rotate_every    - How often the log files should be rotated as a String.
-                  Valid values are 'day', 'week', 'month' and 'year'
+                  Valid values are 'hour', 'day', 'week', 'month' and 'year'
                   (optional).  Please note, older versions of logrotate do not
                   support yearly log rotation.
 size            - The String size a log file has to reach before it will be

diff --git a/Rakefile b/Rakefile
diff --git a/script/bootstrap b/script/bootstrap
@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+bundle install --path vendor/gems --local
diff --git a/script/cibuild b/script/cibuild
@@ -0,0 +1,9 @@
+#!/usr/bin/env sh
+
+set -e
+
+[ -z "${PUPPET_VERSION}" ] && script/bootstrap
+
+bundle exec rspec
+
+bundle exec puppet-lint --with-filename --fail-on-warnings manifests
diff --git a/vendor/cache/facter-1.6.18.gem b/vendor/cache/facter-1.6.18.gem
diff --git a/vendor/cache/facter-1.7.1.gem b/vendor/cache/facter-1.7.1.gem
diff --git a/vendor/cache/hiera-1.0.0.gem b/vendor/cache/hiera-1.0.0.gem
diff --git a/vendor/cache/hiera-1.2.1.gem b/vendor/cache/hiera-1.2.1.gem
diff --git a/vendor/cache/json_pure-1.8.0.gem b/vendor/cache/json_pure-1.8.0.gem
diff --git a/vendor/cache/puppet-3.0.2.gem b/vendor/cache/puppet-3.0.2.gem
diff --git a/vendor/cache/puppet-3.2.1.gem b/vendor/cache/puppet-3.2.1.gem
diff --git a/vendor/cache/rake-0.9.2.2.gem b/vendor/cache/rake-0.9.2.2.gem
diff --git a/vendor/cache/rake-10.0.4.gem b/vendor/cache/rake-10.0.4.gem
diff --git a/vendor/cache/rgen-0.6.2.gem b/vendor/cache/rgen-0.6.2.gem
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		#!/usr/bin/env sh

		bundle install --path vendor/gems --local