#Web Logger
This is a project ported from the original sg-logger to be able to take ownership in the gitlab web group
Getting Started
Dependencies
Tech Stack
CONTRIBUTING
Commit messages
To enforce an auto-generated CHANGELOG these conventions must be followed. A husky hook will validate the commit messages anyways. Please refer to this guid: Conventional Commits
TL;DR The commit contains the following structural elements, to communicate intent to the consumers of your library:
fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in semantic versioning). feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in semantic versioning). BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in semantic versioning). A BREAKING CHANGE can be part of commits of any type.
Types other than fix: and feat: are allowed, for example:
- build:
- chore:
- ci:
- docs:
- style:
- refactor:
- perf:
- test:
Footers other than BREAKING CHANGE: may be provided and follow a convention similar to git trailer format.