CONTRIBUTING.md

Contributing

Welcome! If you're looking to help, this document is a great place to start!

Finding things that need help

Right now this is a bit of a yolo project just because.

Building the project

To build puppet-nanny from source, you will need Go 1.11 or later installed.

go get github.com/gavinelder/puppet-nanny

or

git clone git@github.com:gavinelder/puppet-nanny.git && cd puppet-nanny
make deps
make

Git workflow

username=$GitHubUsername
# add your remote/upstream
git remote add $username git@github.com:$username/puppet-nanny.git

# update from origin/master
git pull --rebase

# create a branch
git checkout -b my_feature

# push changes from my_feature to your fork.
#    -u, --set-upstream    set upstream for git pull/status
git push -u $username

Go Resources

A few helpful resources for getting started with Go:

• Writing, building, installing, and testing Go code
• Resources for new Go programmers
• How I start
• How to write Go code