Skip to content

Commit 8dbaa68

Browse files
committed
#30 - Updated Readme to include a Contributing process for future PRs.
1 parent 66fcc55 commit 8dbaa68

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,4 +110,24 @@ site.pp:
110110
* ensure
111111
* Boolean to disable anything from happening (absent/removal not supported yet)
112112

113+
## Contributing:
114+
115+
Feedback and issues are welcome. The most welcome feedback is a Pull Request. To do this:
116+
117+
1. Navigate to the source repo, and then Fork it into your account using the button in the top-right.
118+
1. Clone your fork onto your localhost and make your desired changes.
119+
1. Run puppet lint. Travis CI will use command:
120+
```
121+
export BUNDLE_GEMFILE=$PWD/.gemfile
122+
bundle exec rake lint
123+
```
124+
1. Run rspec test. Travis CI will use command:
125+
```
126+
bundle exec rake spec SPEC_OPTS=’--format documentation’
127+
```
128+
1. Test everything again
129+
1. Commit your changes and push up into your fork in GitHub.
130+
1. Navigate to your forked repo, then click the green Compare icon in the top-left area of the source window.
131+
1. Compare it to my branch, then click the Create Pull Request button to make a PR using the diff from your branch.
132+
1. Validate that the Travis-CI build is passing on your PR before it gets a human review
113133

0 commit comments

Comments
 (0)