Skip to content

Guidelines.md

Latest commit

 

History

History
28 lines (18 loc) · 1.14 KB

Guidelines.md

File metadata and controls

28 lines (18 loc) · 1.14 KB
Raw

Development Conventions and Guidelines

Git Guidelines

No Merge Commits

Please use rebase instead of merge to update a branch to the latest main. This helps keeping a clean commit history in the project.

Commit Message Style

This project uses the Conventional Commits specification to ensure a consistent way of dealing with commit messages.

fix(xml-transpiler): Log unknown namespaces as verbose instead of warning

Ignoring them seems safe, so no warning should be produced. There's
typically also nothing a developer can do to resolve the warning.

Structure

type(scope): Description
  • required: every commit message has to start with a lowercase type. The project has defined a set of valid types.
  • optional: the scope is typically the affected module. If multiple modules are affected by the commit, skip it or define a meaningful abstract scope.
  • required: the description has to follow the Sentence Case style. Only the first word and proper nouns are written in uppercase.