- Pull requests that add any additional functionality should have tests which cover the new feature to ensure it does what is expected
- Pull requests with failing tests will not be merged
- Keep feature based PRs as small as possible, with as few commits as necessary. These are easier to review and will be merged quicker
- Make sure you reference the issue you're closing with
Fixes #<issue number>
- Squash/rebase any commits where possible to reduce the noise in the PR
Reference the issue number, in the format (GH-###).
(GH-2) Add feature foo
This module supports Sensu v1
The master branch is for development against Sensu Classic.
- Update version in
metadata.json - Update CHANGELOG.md with the following command replacing
--future-releasewith appropriate value.github_changelog_generator -u sensu -p puppet-module-sensuclassic --exclude-labels skip-changelog --future-release v3.2.0 - Update
REFERENCE.mdwith the commandbundle exec rake reference - Commit changes and push to master
- Tag the new version, such as
git tag -a 'v2.0.0' -m 'v2.0.0' - Push tags
git push --tags - Update the puppet strings documentation with
bundle exec rake strings:gh_pages:update - Clean up tests with
bundle exec rake spec_clean - Remove junit directory from beaker runs
rm -fr junit - Build module with
puppet module build - Upload module to Puppet Forge.