Skip to content

Commit 99f5a80

Browse files
committed
update contributing to give guideline on commit message format
1 parent b220e87 commit 99f5a80

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,35 @@ Revisions of this nature will result in a 0.0.X change of the version number.
1919
If major functionality is being added, or there will need to be gestation time for a change, it should be submitted against the __feature__ branch.
2020

2121
Revisions of this nature will result in a 0.X.X change of the version number.
22+
23+
## Commit message format
24+
25+
To support our automated release process, pull requests are required to follow the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/)
26+
format.
27+
28+
Each commit message consists of a **header**, an optional **body** and an optional **footer**. The header is the first line of the commit and
29+
MUST have a **type** (see below for a list of types) and a **description**. An optional **scope** can be added to the header to give extra context.
30+
31+
```
32+
<type>[optional scope]: <short description>
33+
<BLANK LINE>
34+
<optional body>
35+
<BLANK LINE>
36+
<optional footer(s)>
37+
```
38+
39+
The recommended commit types used are:
40+
41+
- **feat** for feature updates (increments the _minor_ version)
42+
- **fix** for bug fixes (increments the _patch_ version)
43+
- **perf** for performance related changes e.g. optimizing an algorithm
44+
- **refactor** for code refactoring changes
45+
- **test** for test suite updates e.g. adding a test or fixing a test
46+
- **style** for changes that don't affect the meaning of code. e.g. formatting changes
47+
- **docs** for documentation updates e.g. ReadMe update or code documentation updates
48+
- **build** for build system changes (gradle updates, external dependency updates)
49+
- **ci** for CI configuration file changes e.g. updating a pipeline
50+
- **chore** for miscallaneous non-sdk changesin the repo e.g. removing an unused file
51+
52+
Adding a footer with the prefix **BREAKING CHANGE:** will cause an increment of the _major_ version.
53+

0 commit comments

Comments
 (0)