From e0f09e865baa954a40a9afb99c1762f58e57e458 Mon Sep 17 00:00:00 2001 From: Esen Dzhailobaev Date: Mon, 28 Mar 2022 18:11:45 +0600 Subject: [PATCH] docs: introduce contributing.md (#222) --- CONTRIBUTING.MD | 122 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 122 insertions(+) create mode 100644 CONTRIBUTING.MD diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD new file mode 100644 index 000000000..d9d1be265 --- /dev/null +++ b/CONTRIBUTING.MD @@ -0,0 +1,122 @@ +# Contributing + +## How we work + +We write code and then do commits, as everyone does. + +Our commits rely on [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#specification) system. + +Releases are tied to the commit messages via [semantic-release](https://github.com/semantic-release/semantic-release). + +Any commit(a PR merge) into `dev`, which is our main branch, is published to NPM under the [`@logicalclocks/quartz` package](https://www.npmjs.com/package/@logicalclocks/quartz). + +## Commit rules + +Basically, [Angular commit message conventions](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-format). + + +Below is just copy-paste: + + +Each commit message consists of a **header**, a **body**, and a **footer**. + + +``` +
+ + + +