|
1 | 1 | # Contributing to the Microsoft Graph PHP SDK Core |
2 | | -Thanks for considering making a contribution! Read over our guidelines and we will do our best to see your PRs merged successfully. |
| 2 | +Thanks for considering making a contribution! Read over our guidelines, and we will do our best to see your PRs merged successfully. |
3 | 3 |
|
4 | 4 | **NOTE**: A signed a contribution license agreement is required for all contributions and is checked automatically on new pull requests. You will be asked to read and sign the agreement https://cla.microsoft.com/ after submitting a request to this repository. |
5 | 5 |
|
6 | 6 | There are a few different recommended paths to get contributions into the released version of this library. |
7 | 7 |
|
8 | 8 | ## File issues |
9 | | -The best way to get started with a contribution is to start a dialog with us. Sometimes features will be under development or out of scope for this library and it's best to check before starting work on contribution, especially for large work items. |
| 9 | +The best way to get started with a contribution is to start a dialog with us. Sometimes features will be under development or out of scope for this library, and it's best to check before starting work on contribution, especially for large work items. |
| 10 | + |
| 11 | +## Commit message format |
| 12 | + |
| 13 | +To support our automated release process, pull requests are required to follow the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) |
| 14 | +format. |
| 15 | + |
| 16 | +Each commit message consists of a **header**, an optional **body** and an optional **footer**. The header is the first line of the commit and |
| 17 | +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. |
| 18 | + |
| 19 | +``` |
| 20 | +<type>[optional scope]: <short description> |
| 21 | +<BLANK LINE> |
| 22 | +<optional body> |
| 23 | +<BLANK LINE> |
| 24 | +<optional footer(s)> |
| 25 | +``` |
| 26 | + |
| 27 | +The recommended commit types used are: |
| 28 | + |
| 29 | +- **feat** for feature updates (increments the _minor_ version) |
| 30 | +- **fix** for bug fixes (increments the _patch_ version) |
| 31 | +- **perf** for performance related changes e.g. optimizing an algorithm |
| 32 | +- **refactor** for code refactoring changes |
| 33 | +- **test** for test suite updates e.g. adding a test or fixing a test |
| 34 | +- **style** for changes that don't affect the meaning of code. e.g. formatting changes |
| 35 | +- **docs** for documentation updates e.g. ReadMe update or code documentation updates |
| 36 | +- **build** for build system changes (gradle updates, external dependency updates) |
| 37 | +- **ci** for CI configuration file changes e.g. updating a pipeline |
| 38 | +- **chore** for miscellaneous non-sdk changes in the repo e.g. removing an unused file |
| 39 | + |
| 40 | +Adding a footer with the prefix **BREAKING CHANGE:** will cause an increment of the _major_ version. |
10 | 41 |
|
11 | 42 | ## Pull requests |
12 | | -If you are making documentation changes, feel free to submit a pull request against the **master** branch. All other pull requests should be submitted against the **dev** branch or a specific feature branch. The master branch is intended to represent the code released in the most-recent composer package. |
| 43 | +If you are making documentation changes, feel free to submit a pull request against the **main** branch. All other pull requests should be submitted against the **main** branch or a specific feature branch. The **main** branch is intended to represent the code released in the most-recent composer package. |
13 | 44 |
|
14 | | -When a new package is about to be released, changes in dev will be merged into master. The package will be generated from master. |
| 45 | +When a new package is about to be released, the release PR will be merged into main. The package will be generated from main. |
15 | 46 |
|
16 | 47 | Some things to note about this project: |
17 | 48 |
|
18 | 49 | ### How the library is built |
19 | 50 | The PHP SDK has a handwritten set of core files. |
20 | 51 |
|
21 | | - |
| 52 | + |
22 | 53 | However, this is evaluated on a case-by-case basis. If the library is missing v1.0 Graph functionality that you wish to utilize, please [file an issue](https://github.com/microsoftgraph/msgraph-sdk-php-core/issues). |
23 | 54 |
|
24 | 55 | We do our best to prevent breaking changes from being introduced into the library during this process. If you find a breaking change, please file an issue and we will work to get this resolved ASAP. |
|
0 commit comments