Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 1.57 KB

conventions.md

File metadata and controls

54 lines (34 loc) · 1.57 KB

Conventions

Contents

Code Style

We follow the Effective Dart code style.

Code should be formatted using dart format (docs).

Commits, Branches and Pull Requests

Branch names should be written using kebab-case and have the following schema:

<issue_key>-your-branch-name

1234-commit-message-documentation

Commit messages and PR names should have the following schema:

<issue_key>: Your commit message

1234: Add commit message documentation

See this guide for a general reference on how to write good commit messages.

Versioning

Versions consist of a version name and a version code and are set in version.yaml. Versions are automatically bumped and committed using the corresponding scripts in tools in the delivery workflows in the CI.

Version Name

We use the calver schema YYYY.MM.PATCH for versioning. PATCH is a counter for the number of releases in the corresponding month starting with 0.

Examples:

  • First versions of 2024: 2024.1.0, 2024.1.1, 2024.1.2.
  • First version of February 2024: 2024.2.0.

Version Code

An additional consecutive version code is used for unique identification in the app stores. The version code has to be incremented for every new release uploaded to the stores.