You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# 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
<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:
Copy file name to clipboardExpand all lines: readme.md
+12-34Lines changed: 12 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,10 @@
1
-
# Microsoft Graph Core Preview SDK for Java
1
+
# Microsoft Graph Core SDK for Java
2
2
3
-
Get started with the Microsoft Graph Core SDK for Java by integrating the [Microsoft Graph API](https://graph.microsoft.io/en-us/getting-started) into your Java application!
3
+
Get started with the Microsoft Graph Core SDK for Java by integrating the [Microsoft Graph API](https://graph.microsoft.io/en-us/getting-started) into your Java and Android application!
4
4
5
-
## Important Note about the Microsoft Graph Core Java Preview
6
-
During the preview we may make changes to the API, and other mechanisms of this library, which you will be required to take along with bug fixes or feature improvements. This may impact your application. An API change may require you to update your code. When we provide the General Availability release we will require you to update to the General Availability version within six months, as applications written using a preview version of library may no longer work.
The nature of the Graph API is such that the SDK needs quite a large set of classes to describe its functionality. You need to ensure that [ProGuard](https://developer.android.com/studio/build/shrink-code.html) is enabled on your project. Otherwise, you will incur long build times for functionality that is not necessarily relevant to your particular application. If you are still hitting the 64K method limit, you can also enable [multidexing](https://developer.android.com/studio/build/multidex.html).
64
38
@@ -70,7 +44,11 @@ Register your application by following the steps at [Register your app with the
70
44
71
45
### 2.2 Create an IAuthenticationProvider object
72
46
73
-
An instance of the **HttpClients** class handles building client. To create a new instance of this class, you need to provide an instance of `ICoreAuthenticationProvider`, which can authenticate requests to Microsoft Graph.
47
+
An instance of the **HttpClients** class handles building client. To create a new instance of this class, you need to provide an instance of `ICoreAuthenticationProvider`, which can authenticate requests to Microsoft Graph.
48
+
### To get instance of HttpClients
49
+
Auth in Java app [here](https://github.com/microsoftgraph/msgraph-sdk-java-auth)
50
+
51
+
Auth in Android app [here](https://github.com/microsoftgraph/msgraph-sdk-android-auth)
74
52
75
53
### 2.3 Get a HttpClients object
76
54
You must get a **HttpClients** object to make requests against the service.
0 commit comments