Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

34 lines (24 loc) · 2.08 KB
Raw

Contributing guidelines

Please make every effort to follow existing conventions and style to keep the code as readable as possible.

Please also make sure your code is ready by running:
./gradlew check.

  • In case of updated dependencies, don't forget to call ./gradlew dependencyGuardBaseline

  • Get working code on a personal branch with all tests before you submit a PR.

  • Please, try to keep the git history flat and clean. Avoid merge commits (except for hotfix branches).

  • Use conventional commits specification for commit messages. Please, use this format for PR titles too.

The expected commit message format is:

type(scope): description

  • The type MUST be one of: feat, fix, test, build, ci, docs, perf, refactor, style, chore, i18n, deps, misc, revert.
  • The scope is optional, but recommended. Any string is allowed; it should indicate what the change affects.
  • The description MUST be pithy and direct short summary of the code changes.
  • The description MUST be in the imperative, present tense: "change" not "changed" nor "changes".
  • A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description.
  • One or more footers MAY be provided one blank line after the body. Each footer MUST consist of a word token, followed by either a : or # separator, followed by a string value.
  • The BREAKING CHANGE footer MAY be provided if this commit introduces a breaking change. The BREAKING CHANGE footer MUST contain a description of the breaking changes, a justification for why the breaking changes were introduced and any migration notes required.
  • See conventionalcommits.org for more details.

The commitizen CLI can help to construct these commit messages (but it's not required).

Examples:

  • build(deps): bump Name Of Lib version to "17.0.2"
  • docs: fix a typo in README.md