Skip to content

Latest commit

 

History

History
24 lines (19 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

24 lines (19 loc) · 1.55 KB
Raw

Contributing to HealthDataSync

This document describes guidelines for contributing to the HealthDataSync repo.

Submitting Pull Requests

  • DO submit all changes via pull requests (PRs). They will be reviewed and potentially be merged by maintainers after a peer review that includes at least one of the team members.
  • DO give PRs short but descriptive names.
  • DO write a useful but brief description of what the PR is for.
  • DO refer to any relevant issues and use keywords that automatically close issues when the PR is merged.
  • DO ensure each commit successfully builds. The entire PR must pass all checks before it will be merged.
  • DO address PR feedback in additional commits instead of amending.
  • DO assume that Squash and Merge will be used to merge the commits unless specifically requested otherwise.
  • DO NOT submit "work in progress" PRs. A PR should only be submitted when it is considered ready for review.
  • DO NOT mix independent and unrelated changes in one PR.

Creating Issues

  • DO use a descriptive title that identifies the issue or the requested feature.
  • DO write a detailed description of the issue or the requested feature.
  • DO provide details for issues you create:
    • Describe the expected and actual behavior.
    • Provide any relevant exception message or OperationOutcome.
  • DO subscribe to notifications for created issues in case there are any follow-up questions.