You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+34-3Lines changed: 34 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,37 @@ If major functionality is being added, or there will need to be gestation time f
20
20
21
21
Revisions of this nature will result in a 0.X.X change of the version number.
22
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
+
23
54
## Add yourself as a contributor
24
55
25
56
This project follows the [all contributors](https://github.com/kentcdodds/all-contributors) specification. When making a contribution, please add yourself to the table of contributors:
@@ -34,8 +65,8 @@ This project follows the [all contributors](https://github.com/kentcdodds/all-co
34
65
You can get your GitHub UID by inspecting your GitHub avatar image.
35
66
36
67
2. For each contribution type (see [emoji key](https://github.com/kentcdodds/all-contributors#emoji-key) for a list of contribution types), add an emoji and a relevant link and alt-text.
37
-
68
+
38
69
For example, if you write a blogpost on how to use the SDK, you would include:
0 commit comments