Skip to content

Latest commit

 

History

History
14 lines (13 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

14 lines (13 loc) · 1.27 KB

Contribution acceptance criteria

  1. The change is as small as possible
  2. Include proper tests and make all tests pass (unless it contains a test exposing a bug in existing code).
    1. Every new file should have corresponding unit tests, even if the class is exercised at a higher level, such as a feature test.
    2. Unit tests must be 70%+ coverage
  3. Your MR initially contains a single commit (please use git rebase -i to squash commits)
  4. Your changes can merge without problems (if not please merge master, never rebase commits pushed to the remote server)
  5. Does not break any existing functionality
  6. Fixes one specific issue or implements one specific feature (do not combine things, send separate merge requests if needed)
  7. Migrations (if any) should do only one thing (e.g., either create a table, move data to a new table or remove an old table) to aid retrying on failure (once we implement migrations)
  8. Contains functionality we think other users will benefit from too
  9. Doesn't add configuration options or settings options since they complicate making and testing future changes (with some exceptions)
  10. Changes after submitting the merge request should be in separate commits (no squashing). If necessary, you will be asked to squash when the review is over, before merging.