Skip to content
This repository has been archived by the owner on Feb 29, 2024. It is now read-only.

Latest commit

 

History

History
38 lines (29 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

38 lines (29 loc) · 2.13 KB

Contributing Guidelines

Developing for cerner_splunk_ingredient should follow these guidelines for submitting issues and pull requests.

Submitting Issues

Issues pertaining to cerner_splunk_ingredient should be submitted to Github's issue tracker.

  1. Issues will be triaged and marked with an appropriate label (e.g. bug, enhancement, question).
  2. A corresponding internal JIRA may be logged if there is a desire for internal discussion or code review.
  3. The issue should be worked in a branch outside of the Cerner repo.
  4. The issue will be marked for the next milestone following a pull request.

Pull Requests

Pull requests for changes should be compared against the 'master' branch.

  1. Your branch should use as few logical commits as possible with descriptive commit messages.
  2. Note: these commits should not reference any issues, that will be done in the merge commit.
  3. Your pull request should reference the issue it is related to.
  4. The pull request is collectively reviewed and commented on, and must get two or more +1's, from reviewers and at least one maintainer of the repo.
    • Any raised comments must be addressed and will be re-reviewed.
  5. Once the pull request is approved, the changes will be merged by a maintainer.
    • This is done manually, not by using the Github button, so that the fix version of metadata.rb can be incremented in the merge. (Example)
    • The merge commit text should reference the issue and the pull request so that both are closed when the merge is pushed.

Releasing

  1. An issue is made to release a new version
  2. The issue will summarize what was changed since the last milestone, and propose the commit to tag and its description.
  3. The issue will be labeled "release"
  4. The issue is reviewed, and must get two or more +1s from reviewers and maintainers.
  5. An annotated tag is created with the reviewed release text.
    • Master is set to the annotated tag.
  6. The cookbook is released to Supermarket
  7. Cleanup
    • The issue and existing milestone is closed
    • A new milestone is created for the next version