Contributing Guide

Git

Branches

• develop - main branch, into which all feature branches have to be merged via pull requests during the sprint

• master - release branch. At the end of each sprint develop is merged into master and then master could be deployed

• feature - feature branches that contain only changes associated with a linked issue

  Naming:

  xy/#N-feature-short-description, where x - a first letter of the first name, y - a first letter of the last name, N - an issue number

  e.g. lt/#0-make-kernel-great-again (Linus Torvalds, issue #0)

Pull requests

Direct commits to develop and master branches are restricted, so all changes MUST be done using Pull requests (PR).

• Each PR MUST be reviewed by at least 1 other developer
• Each PR MUST be approved by a reviewer for the merging
• All status checks (CI tests, analyzers ...) MUST be passed
• Merge MUST be done using a Squash and merge option and resulting commit message should contain a link to issue (#N)

Commits

Commit message MUST be clear and comprehensive. E.g. fix NPE in Auth service - is OK and fix or some changes - are bad ones.

Java

• TODO

JS

• TODO