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
+30Lines changed: 30 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,36 @@ When a new package is about to be released, changes in dev will be merged into m
15
15
16
16
Some things to note about this project:
17
17
18
+
## Commit message format
19
+
To support our automated release process, pull requests are required to follow the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/)
20
+
format.
21
+
22
+
Each commit message consists of a **header**, an optional **body** and an optional **footer**. The header is the first line of the commit and
23
+
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.
24
+
25
+
```
26
+
<type>[optional scope]: <short description>
27
+
<BLANK LINE>
28
+
<optional body>
29
+
<BLANK LINE>
30
+
<optional footer(s)>
31
+
```
32
+
33
+
The recommended commit types used are:
34
+
35
+
-**feat** for feature updates (increments the _minor_ version)
36
+
-**fix** for bug fixes (increments the _patch_ version)
37
+
-**perf** for performance related changes e.g. optimizing an algorithm
38
+
-**refactor** for code refactoring changes
39
+
-**test** for test suite updates e.g. adding a test or fixing a test
40
+
-**style** for changes that don't affect the meaning of code. e.g. formatting changes
41
+
-**docs** for documentation updates e.g. ReadMe update or code documentation updates
42
+
-**build** for build system changes (gradle updates, external dependency updates)
43
+
-**ci** for CI configuration file changes e.g. updating a pipeline
44
+
-**chore** for miscallaneous non-sdk changesin the repo e.g. removing an unused file
45
+
46
+
Adding a footer with the prefix **BREAKING CHANGE:** will cause an increment of the _major_ version.
47
+
18
48
### How the library is built
19
49
The .Net client library has a handwritten set of core files and two folders of generated models and request builders. These models and request builders are generated using the [MSGraph SDK Code Generator](https://github.com/microsoftgraph/MSGraph-SDK-Code-Generator). **Changes made to the ```Models``` and ```Requests``` folders will be overwritten** the next time the generator is run.
0 commit comments