Skip to content

Commit 003b8f5

Browse files
authored
feat: adds changelog and contributing (#1368)
* feat: adds changelog and contributing * feat: update changelog
1 parent 0be3ce1 commit 003b8f5

File tree

3 files changed

+75
-9
lines changed

3 files changed

+75
-9
lines changed

CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

CONTRIBUTING.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
## Contributing
2+
3+
This project welcomes contributions and suggestions. Most contributions require you to agree to a
4+
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
5+
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
6+
7+
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
8+
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
9+
provided by the bot. You will only need to do this once across all repos using our CLA.
10+
11+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
12+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
13+
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
14+
15+
## File issues
16+
17+
The best way to get started with a contribution is to start a dialog with the owners of this repository. Sometimes features will be under development or out of scope for this SDK and it's best to check before starting work on contribution.
18+
19+
## Commit message format
20+
21+
To support our automated release process, pull requests are required to follow the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/)
22+
format.
23+
24+
Each commit message consists of a **header**, an optional **body** and an optional **footer**. The header is the first line of the commit and
25+
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.
26+
27+
```
28+
<type>[optional scope]: <short description>
29+
<BLANK LINE>
30+
<optional body>
31+
<BLANK LINE>
32+
<optional footer(s)>
33+
```
34+
35+
The recommended commit types used are:
36+
37+
- **feat** for feature updates (increments the _minor_ version)
38+
- **fix** for bug fixes (increments the _patch_ version)
39+
- **perf** for performance related changes e.g. optimizing an algorithm
40+
- **refactor** for code refactoring changes
41+
- **test** for test suite updates e.g. adding a test or fixing a test
42+
- **style** for changes that don't affect the meaning of code. e.g. formatting changes
43+
- **docs** for documentation updates e.g. ReadMe update or code documentation updates
44+
- **build** for build system changes (gradle updates, external dependency updates)
45+
- **ci** for CI configuration file changes e.g. updating a pipeline
46+
- **chore** for miscallaneous non-sdk changesin the repo e.g. removing an unused file
47+
48+
Adding a footer with the prefix **BREAKING CHANGE:** will cause an increment of the _major_ version.

release-please-config.json

+21-9
Original file line numberDiff line numberDiff line change
@@ -8,51 +8,63 @@
88
"include-component-in-tag": true,
99
"include-v-in-tag": true,
1010
"separate-pull-requests": false,
11+
"bump-minor-pre-major": true,
12+
"bump-patch-for-minor-pre-major": true,
13+
"versioning": "always-bump-minor",
1114
"packages": {
1215
"packages/abstractions": {
1316
"name": "@microsoft/kiota-abstractions",
1417
"path": "packages/abstractions",
15-
"release-type": "node"
18+
"release-type": "node",
19+
"changelog-path": "CHANGELOG.md"
1620
},
1721
"packages/authentication/azure": {
1822
"name": "@microsoft/kiota-authentication-azure",
1923
"path": "packages/authentication/azure",
20-
"release-type": "node"
24+
"release-type": "node",
25+
"changelog-path": "CHANGELOG.md"
2126
},
2227
"packages/authentication/spfx": {
2328
"name": "@microsoft/kiota-authentication-spfx",
2429
"path": "packages/authentication/spfx",
25-
"release-type": "node"
30+
"release-type": "node",
31+
"changelog-path": "CHANGELOG.md"
2632
},
2733
"packages/bundle": {
2834
"name": "@microsoft/kiota-bundle",
2935
"path": "packages/bundle",
30-
"release-type": "node"
36+
"release-type": "node",
37+
"changelog-path": "CHANGELOG.md"
3138
},
3239
"packages/http/fetch": {
3340
"name": "@microsoft/kiota-http-fetchlibrary",
3441
"path": "packages/http/fetch",
35-
"release-type": "node"
42+
"release-type": "node",
43+
"changelog-path": "CHANGELOG.md"
3644
},
3745
"packages/serialization/form": {
3846
"name": "@microsoft/kiota-serialization-form",
3947
"path": "packages/serialization/form",
40-
"release-type": "node"
48+
"release-type": "node",
49+
"changelog-path": "CHANGELOG.md"
4150
},
4251
"packages/serialization/json": {
4352
"name": "@microsoft/kiota-serialization-json",
4453
"path": "packages/serialization/json",
45-
"release-type": "node"
54+
"release-type": "node",
55+
"changelog-path": "CHANGELOG.md"
4656
},
4757
"packages/serialization/multipart": {
4858
"name": "@microsoft/kiota-serialization-multipart",
4959
"path": "packages/serialization/multipart",
50-
"release-type": "node"
60+
"release-type": "node",
61+
"changelog-path": "CHANGELOG.md"
5162
},
5263
"packages/serialization/text": {
5364
"name": "@microsoft/kiota-serialization-text",
5465
"path": "packages/serialization/text",
55-
"release-type": "node"
66+
"release-type": "node",
67+
"changelog-path": "CHANGELOG.md"
5668
}
5769
},
5870
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"

0 commit comments

Comments
 (0)