Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.23 KB

File metadata and controls

42 lines (28 loc) · 1.23 KB

Contributing guidelines

Commit messages

Commits in MUST follow Conventional Commits with these values used as a type field:

  • ft (not feat) for features
  • fix for bug fixes
  • docs for documentation changes
  • test for expanding test suite
  • chore for rest of maintenance tasks like CI changes

Scope MUST be omitted.

Subject SHOULD start with lowercase, but that is not strictly enforced.

Example of good commit message

ft: add formatter for Foo

Foo is format used by service XYZ

Close #42

PRs not conforming to that template will be automatically marked as invalid/commit-messages.

Code style

Your code MUST be formatted with mix format. PRs containing non-conforming code will be automatically marked as invalid/format.

Your code MUST pass mix credo check. PRs that will fail such test will be automatically marked as invalid/credo.