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
-[Creating a Pull Request](#creating-a-pull-request)
12
12
13
13
<aname="roadmap"></a>
14
14
We use [Milestones](https://github.com/sendgrid/sendgrid-java/milestones) to help define current roadmaps, please feel free to grab an issue from the current milestone. Please indicate that you have begun work on it to avoid collisions. Once a PR is made, community review, comments, suggestions and additional PRs are welcomed and encouraged.
@@ -26,7 +26,7 @@ When you create a Pull Request, after a few seconds, a comment will appear with
26
26
27
27
There are a few ways to contribute, which we'll enumerate below:
28
28
29
-
<aname="feature_request"></a>
29
+
<aname="feature-request"></a>
30
30
## Feature Request
31
31
32
32
If you'd like to make a feature request, please read this section.
@@ -36,7 +36,7 @@ The GitHub issue tracker is the preferred channel for library feature requests,
36
36
- Please **search for existing issues** in order to ensure we don't have duplicate bugs/feature requests.
37
37
- Please be respectful and considerate of others when commenting on issues
38
38
39
-
<aname="submit_a_bug_report"></a>
39
+
<aname="submit-a-bug-report"></a>
40
40
## Submit a Bug Report
41
41
42
42
Note: DO NOT include your credentials in ANY code examples, descriptions, or media you make public.
@@ -53,7 +53,7 @@ Before you decide to create a new issue, please try the following:
53
53
54
54
In order to make the process easier, we've included a [sample bug report template](https://github.com/sendgrid/sendgrid-java/blob/master/.github/ISSUE_TEMPLATE) (borrowed from [Ghost](https://github.com/TryGhost/Ghost/)). The template uses [GitHub flavored markdown](https://help.github.com/articles/github-flavored-markdown/) for formatting.
55
55
56
-
<aname="improvements_to_the_codebase"></a>
56
+
<aname="improvements-to-the-codebase"></a>
57
57
## Improvements to the Codebase
58
58
59
59
We welcome direct contributions to the sendgrid-java code base. Thank you!
@@ -105,7 +105,7 @@ Add the example you want to test to Example.java, including the headers at the t
105
105
javac -classpath ../repo/com/sendgrid/4.1.1/sendgrid-4.1.0-jar.jar:. Example.java && java -classpath ../repo/com/sendgrid/4.1.0/sendgrid-4.1.1-jar.jar:. Example
106
106
```
107
107
108
-
<aname="understanding_the_codebase"></a>
108
+
<aname="understanding-the-codebase"></a>
109
109
## Understanding the Code Base
110
110
111
111
**/examples**
@@ -149,7 +149,7 @@ For the purposes of contributing to this repo, please update the [`SendGridTest.
Generally, we follow the style guidelines as suggested by the official language. However, we ask that you conform to the styles that already exist in the library. If you wish to deviate, please explain your reasoning.
@@ -158,7 +158,8 @@ Please run your code through:
158
158
-[FindBugs](http://findbugs.sourceforge.net/)
159
159
-[CheckStyle](http://checkstyle.sourceforge.net/) with [Google's Java Style Guide](http://checkstyle.sourceforge.net/reports/google-java-style.html).
160
160
161
-
## Creating a Pull Request<aname="creating_a_pull_request"></a>
161
+
<aname="creating-a-pull-request"></a>
162
+
## Creating a Pull Request
162
163
163
164
1.[Fork](https://help.github.com/fork-a-repo/) the project, clone your fork,
-[v3 Web API Mail Send Helper](https://github.com/sendgrid/sendgrid-java/tree/master/src/main/java/com/sendgrid/helpers) - build a request object payload for a v3 /mail/send API call.
181
181
182
182
183
-
<aname="use_cases"></a>
183
+
<aname="use-cases"></a>
184
184
# Use Cases
185
185
186
186
[Examples of common API use cases](https://github.com/sendgrid/sendgrid-java/blob/master/USE_CASES.md), such as how to send an email with a transactional template.
@@ -204,10 +204,10 @@ We encourage contribution to our libraries (you might even score some nifty swag
For this example, we assume you have created a [transactional template](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html). Following is the template content we used for testing.
0 commit comments