code-convention.md

Code convention

Git workflow

The follow git workflow is Scaled Trunk-Based Development.

1. main is the only long-lived branch
2. All other branches are short-lived branches

Git commit messages

Commit messages must follow the specification from Conventional Commits.

To help you to choose the right type or scope, you can commit:

• from the dedicated extension in Source Control tab of vscode
• from the terminal via commitizen with the command npx cz

run

Function names

• Format as following: [purpose]:[scope] where it may have multiple sub-scopes separated by :
• Use : to separate scopes
• Use - (kebab-case) for scope names or purposes
• Use _ (snake_case) for helper functions that should not directly be used by the CLI

function install:dev:dotnet-core:global {
  ...
}

In the above example, dev and dotnet-core are scopes and separated by :.