Contributing to the project

Restricted branches

development - all the implemented features which are done and deployed
master - stable version deployed

Workflow

Create a feature branch when you start to work on a story and commit your changes to this
- the branch should be named <id of the ticket>: <subject>, for example SMA 3 Add login endpoint
- the commits should also be named <id of the ticket>: <subject>, for example SMA 3 added unit tests
Push this frequently to the remote repository from your local
When the feature is done, create a Pull Request from the feature_branch to development, follow the guidelines
When the PR is approved, merge it, and delete your feature branch

Git Commit Guidelines

Read this article how to write meaningful commit messages: How to Write a Git Commit Message

We follow the rules below:

Commit message format: SMA {id} <subject>
id: Id of the ticket you are working on (in jira)
Subject: Changes in the commit

Pull Request guidelines

From feature_branch to development: add two developers and PM as reviewers, 3 approves needed for merging
From development to master: this is managed by the PM