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
The SendGrid open source community is made up of members from around the globe with a diverse set of skills, personalities, and experiences. It is through these differences that our community experiences successes and continued growth. When you're working with members of the community, we encourage you to follow these guidelines, which help steer our interactions and strive to maintain a positive, successful and growing community.
5
+
6
+
### Be Open
7
+
Members of the community are open to collaboration, whether it's on pull requests, code reviews, approvals, issues or otherwise. We're receptive to constructive comments and criticism, as the experiences and skill sets of all members contribute to the whole of our efforts. We're accepting of all who wish to take part in our activities, fostering an environment where anyone can participate, and everyone can make a difference.
8
+
9
+
### Be Considerate
10
+
Members of the community are considerate of their peers, which include other contributors and users of SendGrid. We're thoughtful when addressing the efforts of others, keeping in mind that often the labor was completed with the intent of the good of the community. We're attentive in our communications, whether in person or online, and we're tactful when approaching differing views.
11
+
12
+
### Be Respectful
13
+
Members of the community are respectful. We're respectful of others, their positions, their skills, their commitments and their efforts. We're respectful of the volunteer efforts that permeate the SendGrid community. We're respectful of the processes outlined in the community, and we work within them. When we disagree, we are courteous in raising our issues. Overall, we're good to each other. We contribute to this community not because we have to, but because we want to. If we remember that, these guidelines will come naturally.
14
+
15
+
## Additional Guidance
16
+
17
+
### Disclose Potential Conflicts of Interest
18
+
Community discussions often involve interested parties. We expect participants to be aware when they are conflicted due to employment or other projects they are involved in and disclose those interests to other project members. When in doubt, over-disclose. Perceived conflicts of interest are important to address so that the community’s decisions are credible even when unpopular, difficult or favorable to the interests of one group over another.
19
+
20
+
### Interpretation
21
+
This Code is not exhaustive or complete. It is not a rulebook; it serves to distill our common understanding of a collaborative, shared environment and goals. We expect it to be followed in spirit as much as in the letter. When in doubt, try to abide by [SendGrid’s cultural values](https://sendgrid.com/blog/employee-engagement-the-4h-way) defined by our “4H’s”: Happy, Hungry, Humble and Honest.
22
+
23
+
### Enforcement
24
+
Most members of the SendGrid community always comply with this Code, not because of the existence of this Code, but because they have long experience participating in open source communities where the conduct described above is normal and expected. However, failure to observe this Code may be grounds for suspension, reporting the user for abuse or changing permissions for outside contributors.
25
+
26
+
## If you have concerns about someone’s conduct
27
+
**Initiate Direct Contact** - It is always appropriate to email a community member (if contact information is available), mention that you think their behavior was out of line, and (if necessary) point them to this Code.
28
+
29
+
**Discuss Publicly** - Discussing publicly is always acceptable. Note, though, that approaching the person directly may be better, as it tends to make them less defensive, and it respects the time of other community members, so you probably want to try direct contact first.
30
+
31
+
**Contact the Moderators** - You can reach the SendGrid moderators by emailing dx@sendgrid.com.
32
+
33
+
## Submission to SendGrid Repositories
34
+
Finally, just a reminder, changes to the SendGrid repositories will only be accepted upon completion of the [SendGrid Contributor Agreement](https://cla.sendgrid.com).
35
+
36
+
## Attribution
37
+
38
+
SendGrid thanks the following, on which it draws for content and inspiration:
39
+
40
+
*[Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/)
41
+
*[Open Source Initiative General Code of Conduct](https://opensource.org/codeofconduct)
42
+
*[Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html)
-[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.
@@ -51,9 +51,9 @@ Before you decide to create a new issue, please try the following:
51
51
52
52
### Please use our Bug Report Template
53
53
54
-
In order to make the process easier, we've included a [sample bug report template](https://github.com/sendgrid/sendgrid-java/.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.
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!
@@ -102,10 +102,10 @@ touch Example.java
102
102
Add the example you want to test to Example.java, including the headers at the top of the file.
103
103
104
104
```bash
105
-
javac -classpath ../repo/com/sendgrid/4.1.0/sendgrid-4.1.0-jar.jar:. Example.java && java -classpath ../repo/com/sendgrid/4.1.0/sendgrid-4.1.0-jar.jar:. Example
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**
@@ -129,7 +129,7 @@ All test files are in the [`tests`](https://github.com/sendgrid/sendgrid-java/tr
129
129
130
130
For the purposes of contributing to this repo, please update the [`SendGridTest.java`](https://github.com/sendgrid/sendgrid-java/tree/master/src/test/java/com/sendgrid/SendGridTest.java) file with unit tests as you modify the code.
131
131
132
-
1. Download [prism](https://stoplight.io/prism/) for your platform ([Mac OS X](https://github.com/stoplightio/prism/releases/download/v0.1.5/prism_darwin_amd64)) and save the binary to the sendgrid-ruby directory (or any directory you would like. The sendgrid-ruby directory is chosen mostly for convenience.)
132
+
1. Download [prism](http://stoplight.io/platform/prism/) for your platform ([Mac OS X](https://github.com/stoplightio/prism/releases/download/v0.6.21/prism_darwin_amd64), [Linux](https://github.com/stoplightio/prism/releases/download/v0.6.21/prism_linux_amd64), [Windows](https://github.com/stoplightio/prism/releases/download/v0.6.21/prism_windows_amd64.exe)) and save the binary to the sendgrid-java directory (or any directory you would like. The sendgrid-java directory is chosen mostly for convenience.)
133
133
134
134
1. Add execute permissions
135
135
@@ -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,9 @@ 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
163
+
162
164
163
165
1.[Fork](https://help.github.com/fork-a-repo/) the project, clone your fork,
164
166
and configure the remotes:
@@ -167,7 +169,7 @@ Please run your code through:
167
169
# Clone your fork of the repo into the current directory
**NEW:** Subscribe to email [notifications](https://dx.sendgrid.com/newsletter/java) for releases and breaking changes.
5
11
@@ -9,21 +15,22 @@ Version 3.X.X of this library provides full support for all SendGrid [Web API v3
9
15
10
16
This library represents the beginning of a new path for SendGrid. We want this library to be community driven and SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/sendgrid/sendgrid-java/issues) and [pull requests](https://github.com/sendgrid/sendgrid-java/blob/master/CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests.
11
17
12
-
Please browse the rest of this README for further detail.
18
+
Please browse the rest of this README for further details.
13
19
14
20
We appreciate your continued support, thank you!
15
21
16
22
# Table of Contents
17
23
18
24
*[Installation](#installation)
19
-
*[Quick Start](#quick_start)
25
+
*[Quick Start](#quick-start)
20
26
*[Usage](#usage)
21
-
*[Use Cases](#use_cases)
27
+
*[Use Cases](#use-cases)
22
28
*[Announcements](#announcements)
23
29
*[Roadmap](#roadmap)
24
30
*[How to Contribute](#contribute)
25
31
*[Troubleshooting](#troubleshooting)
26
32
*[About](#about)
33
+
*[License](#license)
27
34
28
35
<aname="installation"></a>
29
36
# Installation
@@ -54,7 +61,7 @@ Add the following to your build.gradle file in the root of your project.
54
61
...
55
62
dependencies {
56
63
...
57
-
compile 'com.sendgrid:sendgrid-java:4.1.0'
64
+
compile 'com.sendgrid:sendgrid-java:4.1.1'
58
65
}
59
66
60
67
repositories {
@@ -79,7 +86,7 @@ You can just drop the jar file in. It's a fat jar - it has all the dependencies
-[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
188
182
189
183
-
<aname="use_cases"></a>
190
+
<aname="use-cases"></a>
184
191
# Use Cases
185
192
186
193
[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 +211,10 @@ We encourage contribution to our libraries (you might even score some nifty swag
0 commit comments