Skip to content

Latest commit

 

History

History
47 lines (28 loc) · 1.37 KB

CONTRIBUTING.md

File metadata and controls

47 lines (28 loc) · 1.37 KB
Raw

Contributing Guideline

Topics

The Flow

We follow The Git Flow.

You can read about it in details here.

Branching Rules

  • features are being developed in a separate branches derived from develop
  • hotfixes are being developed in a separate branches derived from master
  • tags are being used when a release is made
  • any merge into master and develop must be done with a Pull Request

Committing

You can read about the topic here.

Committing Rules

  • the first word of a commit message must start with a Capital
  • the length of the subject line should be near 50 symbols
  • use the imperative mood in the subject line
  • the period at the end of the subject line is prohibited
  • exception it is considered ok to have more than one commit with the same subject line (repeatable commits within the same task)

The correct subject line of a commit message must complete the following sentence:

If applied, this commit will your subject line here

The Correct Example:

If applied, this commit will Refactor subsystem X for readability

The INCORRECT Example:

If applicaed, this commit will fixed bug with Y

Or

If applied, this commit will changing behavior of Z