|
| 1 | +# Contributing to the Microsoft Graph Core SDK for Java |
| 2 | + |
| 3 | +The Microsoft Graph Core SDK for Java is available for all manner of contribution. There are a couple of different recommended paths to get contributions into the released version of this SDK. |
| 4 | + |
| 5 | +__NOTE__ A signed a contribution license agreement is required for all contributions, and is checked automatically on new pull requests. Please read and sign the agreement https://cla.microsoft.com/ before starting any work for this repository. |
| 6 | + |
| 7 | +## File issues |
| 8 | + |
| 9 | +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. |
| 10 | + |
| 11 | +## Submit pull requests for trivial changes |
| 12 | + |
| 13 | +If you are making a change that does not affect the interface components and does not affect other downstream callers, feel free to make a pull request against the __dev__ branch. The dev branch will be updated frequently. |
| 14 | + |
| 15 | +Revisions of this nature will result in a 0.0.X change of the version number. |
| 16 | + |
| 17 | +## Submit pull requests for features |
| 18 | + |
| 19 | +If major functionality is being added, or there will need to be gestation time for a change, it should be submitted against the __feature__ branch. |
| 20 | + |
| 21 | +Revisions of this nature will result in a 0.X.X change of the version number. |
| 22 | + |
| 23 | +## Add yourself as a contributor |
| 24 | + |
| 25 | +This project follows the [all contributors](https://github.com/kentcdodds/all-contributors) specification. When making a contribution, please add yourself to the table of contributors: |
| 26 | + |
| 27 | + 1. In section 5. of the [README.md](https://github.com/microsoftgraph/msgraph-sdk-java-core/blob/dev/readme.md), after the last "|", copy and paste a new blank contributor element |
| 28 | + ```html |
| 29 | + [<img src="https://avatars.githubusercontent.com/u/<your-uid>?v=4" width="100px;"/><br /> |
| 30 | + <sub><b>Your Name</b></sub>](your website or github page)<br /> |
| 31 | + [emoji](link "alt-text") | |
| 32 | + ``` |
| 33 | + |
| 34 | + You can get your GitHub UID by inspecting your GitHub avatar image. |
| 35 | + |
| 36 | +2. For each contribution type (see [emoji key](https://github.com/kentcdodds/all-contributors#emoji-key) for a list of contribution types), add an emoji and a relevant link and alt-text. |
| 37 | + |
| 38 | + For example, if you write a blogpost on how to use the SDK, you would include: |
| 39 | + |
| 40 | + ```html |
| 41 | + [??]("https://myblog.com/using-the-java-sdk" "Blog Post") |
0 commit comments