Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

62 lines (40 loc) · 2.25 KB

Contributing

Pull Requests

When submitting a pull request please have your commits follow these guidelines:

Git Commit Guidelines

This project uses conventional commits for it's commit message format and expects all contributors to follow these guidelines.

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Any line of the commit message should not be longer 100 characters. This allows the message to be easier to read on github as well as in various git tools.

Type

Must be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug or adds a feature
  • perf: A code change that improves performance
  • test: Adding missing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
  • ci: Changes to CI/CD scripts and tooling

Scope

The scope is optional but should be included when possible and refer to a module that is being touched. Examples:

  • codegen
  • rt (optionally the target platform e.g. rt-android)

Subject

The subject contains succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize first letter
  • no dot (.) at the end

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes" The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.

The last line of commits introducing breaking changes should be in the form BREAKING CHANGE: <desc>

Breaking changes should also add an exclamation mark ! after the type/scope (e.g. refactor(rt)!: drop support for Android API < 20)