Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

66 lines (44 loc) · 1.93 KB
Raw

Contribution Guidelines

Tests

  • 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

Features

  • Keep feature based PRs as small as possible, with as few commits as necessary. These are easier to review and will be merged quicker

Bug Fixes

  • Make sure you reference the issue you're closing with Fixes #<issue number>

Commits

  • Squash/rebase any commits where possible to reduce the noise in the PR

Git commits

Reference the issue number, in the format (GH-###).

(GH-901) Add support for Sensu v2

Versions

v2 of this module supports Sensu v1 v3 of this module supports Sensu v2

Branches

master

The master branch is for development against Sensu v1. Once Sensu v2 is no longer beta, master will switch to target that.

sensu2

The sensu2 branch is for development against Sensu v2. Please target any commits for Sensu v2 against this branch.

sensu1

The sensu1 branch does not exist yet, though will once master targets Sensu v2. Sensu v1 will continue to be supported and changes to that version would then target this branch.

Release process

  1. update version in metadata.json
  2. run github_changelog_generator
  3. update CHANGELOG.md and change unreleased at the top to the version, such as v2.0.0, and change HEAD to the same version, such as v2.0.0.
  4. Update REFERENCE.md with the command bundle exec rake reference
  5. Commit changes and push to master
  6. Tag the new version, such as git tag -a 'v2.0.0' -m 'v2.0.0'
  7. Push tags git push --tags
  8. Update the puppet strings documentation with bundle exec rake strings:gh_pages:update
  9. Clean up tests with bundle exec rake spec_clean
  10. Remove junit directory from beaker runs rm -fr junit
  11. Build module with puppet module build
  12. Upload module to Puppet Forge.