From 59122afcc9db804516c6c6f2932e9a545181ea47 Mon Sep 17 00:00:00 2001 From: Joshua Hoblitt Date: Sun, 7 Jun 2015 13:21:53 -0700 Subject: [PATCH] update README boilerplate --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c73a8f1..d53a5e4 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,8 @@ Puppet nsstools Module * [Tested Platforms](#tested-platforms) 5. [Versioning](#versioning) 6. [Support](#support) -7. [See Also](#see-also) +7. [Contributing](#contributing) +8. [See Also](#see-also) Overview @@ -360,6 +361,25 @@ Adding other Linux distributions and operatingsystems should be trivial. * el6.x +Contributing +------------ + +1. Fork it on github +2. Make a local clone of your fork +3. Create a topic branch. Eg, `feature/mousetrap` +4. Make/commit changes + * Commit messages should be in [imperative tense](http://git-scm.com/book/ch5-2.html) + * Check that linter warnings or errors are not introduced - `bundle exec rake lint` + * Check that `Rspec-puppet` unit tests are not broken and coverage is added for new + features - `bundle exec rake spec` + * Documentation of API/features is updated as appropriate in the README + * If present, `beaker` acceptance tests should be run and potentially + updated - `bundle exec rake beaker` +5. When the feature is complete, rebase / squash the branch history as + necessary to remove "fix typo", "oops", "whitespace" and other trivial commits +6. Push the topic branch to github +7. Open a Pull Request (PR) from the *topic branch* onto parent repo's `master` branch + Versioning ----------