vendure/CONTRIBUTING.md

Contribution Guidelines

Commit message format

This repo uses Conventional Commits.

type(scope): Message in present tense

type may be one of:

• feat (new feature)
• fix (bug fix)
• docs (changes to documentation)
• style (formatting, missing semi colons, etc; no code change)
• refactor (refactoring production code)
• test (adding missing tests, refactoring tests; no production code change)
• chore (updating build tasks etc; no production code change)

scope indicates the package affected by the commit:

• admin-ui
• admin-ui-plugin
• asset-server-plugin
• common
• core
• create
• email-plugin
• etc.

If a commit affects more than one package, seperate them with a comma:

fix(core,common): Fix the thing

If a commit applies to no particular package (e.g. a tooling change in the root package.json), the scope can be omitted.

Linting

Commit messages are linted on commit, so you'll know if your message is not quite right.