Skip to content
This repository has been archived by the owner on Dec 26, 2022. It is now read-only.

Latest commit

 

History

History
21 lines (17 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

21 lines (17 loc) · 1.35 KB

I'd love to have your help, but please don't skimp on greatness!

Please check the Issues and the Main Board to make sure what you want is not already being worked on.

  • Please create an issue and use the Main Board to denote its status
    • Please tag the issue with the appropriate labels as well (i.e. status, bug, TODO, etc.)
    • Each issue should have clear details (i.e. steps to reproduce if it's a bug or acceptance criteria if a new feature)
  • Please branch off develop to do any new work
    • Branches should be prefixed with issue-# and a short description
  • Please make sure all static code analysis checks pass
  • Please write tests
  • Please make sure current tests pass
  • Please help maintain the KDocs and write new ones
  • Once satisfied with your work, please submit a Pull Request and I'll be happy to review it! All PRs need to be reviewed by a code owner.

For merging:

  • PRs will be squashed and merged after a rebase
    • The commit should have issue-# in its description
    • Signed commits are required
    • The branch must be up-to-date before merging