Skip to content

Contribution Guidelines

rrowlands edited this page Oct 20, 2022 · 8 revisions

Commit messages must adhere to the conventional commits specification. Commit messages are validated via commit lint, with the @commitlint/config-conventional configuration. Strict adherence to these conventions is important in order to guarantee properly generated release notes. This commit lint validation is automatically installed on developer's machines via the npm install command when executed in georegistry-web/src/main/ng2.

Additionally, Github tickets may be linked as follows:

fix(scope): test commit message (refs #848)

where the (refs #ticketnumber) is required syntax.

Clone this wiki locally