Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

47 lines (29 loc) · 1.36 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

As of v3.0.0, this module supports Sensu V5 aka Sensu Go. Previous versions supported Sensu Classic which can be found at https://github.com/sensu/puppet-module-sensuclassic

Branches

master

The master branch is for development against Sensu Go v5.

Release process

  1. Update version in metadata.json
  2. Run Rake task to release module: pdk bundle exec rake release
  3. Update GitHub pages: pdk bundle exec rake strings:gh_pages:update
  4. Tag the release, such as git tag -a 'v3.11.0' -m 'v3.11.0'
  5. Push release to upstream master: git push upstream master
  6. Push tags upstream master: git push upstream --tags