-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: adds changelog and contributing (#1368)
* feat: adds changelog and contributing * feat: update changelog
- Loading branch information
Showing
3 changed files
with
75 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Changelog | ||
|
||
All notable changes to this project will be documented in this file. | ||
|
||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
## Contributing | ||
|
||
This project welcomes contributions and suggestions. Most contributions require you to agree to a | ||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us | ||
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. | ||
|
||
When you submit a pull request, a CLA bot will automatically determine whether you need to provide | ||
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions | ||
provided by the bot. You will only need to do this once across all repos using our CLA. | ||
|
||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or | ||
contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
|
||
## File issues | ||
|
||
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. | ||
|
||
## Commit message format | ||
|
||
To support our automated release process, pull requests are required to follow the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) | ||
format. | ||
|
||
Each commit message consists of a **header**, an optional **body** and an optional **footer**. The header is the first line of the commit and | ||
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. | ||
|
||
``` | ||
<type>[optional scope]: <short description> | ||
<BLANK LINE> | ||
<optional body> | ||
<BLANK LINE> | ||
<optional footer(s)> | ||
``` | ||
|
||
The recommended commit types used are: | ||
|
||
- **feat** for feature updates (increments the _minor_ version) | ||
- **fix** for bug fixes (increments the _patch_ version) | ||
- **perf** for performance related changes e.g. optimizing an algorithm | ||
- **refactor** for code refactoring changes | ||
- **test** for test suite updates e.g. adding a test or fixing a test | ||
- **style** for changes that don't affect the meaning of code. e.g. formatting changes | ||
- **docs** for documentation updates e.g. ReadMe update or code documentation updates | ||
- **build** for build system changes (gradle updates, external dependency updates) | ||
- **ci** for CI configuration file changes e.g. updating a pipeline | ||
- **chore** for miscallaneous non-sdk changesin the repo e.g. removing an unused file | ||
|
||
Adding a footer with the prefix **BREAKING CHANGE:** will cause an increment of the _major_ version. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters