Skip to content

Latest commit

 

History

History
48 lines (36 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

48 lines (36 loc) · 2.58 KB
Raw

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. For more information see the Code of Conduct FAQ or contact [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 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.