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.
3
+
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.
4
4
5
5
### Be Open
6
+
6
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.
7
8
8
9
### Be Considerate
10
+
9
11
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.
10
12
11
13
### Be Respectful
12
-
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.
13
14
14
-
## Additional Guidance
15
+
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 treat each other well. We contribute to this community not because we have to, but because we want to. If we remember that, these guidelines will come naturally.
16
+
17
+
## Additional Guidance
15
18
16
19
### Disclose Potential Conflicts of Interest
20
+
17
21
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.
18
22
19
23
### Interpretation
20
-
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.
24
+
25
+
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.
21
26
22
27
### Enforcement
28
+
23
29
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.
24
30
25
31
## If you have concerns about someone’s conduct
32
+
26
33
**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.
27
34
28
35
**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.
29
36
30
37
**Contact the Moderators** - You can reach the SendGrid moderators by emailing dx@sendgrid.com.
31
38
32
39
## Submission to SendGrid Repositories
33
-
Finally, just a reminder, changes to the SendGrid repositories will only be accepted upon completion of the [SendGrid Contributor Agreement](https://cla.sendgrid.com).
40
+
41
+
Finally, just a reminder, changes to the SendGrid repositories will only be accepted upon completion of the [SendGrid Contributor Agreement](https://cla.sendgrid.com).
34
42
35
43
## Attribution
36
44
37
45
SendGrid thanks the following, on which it draws for content and inspiration:
38
46
39
-
*[Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/)
40
-
*[Open Source Initiative General Code of Conduct](https://opensource.org/codeofconduct)
41
-
*[Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html)
47
+
-[Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/)
48
+
-[Open Source Initiative General Code of Conduct](https://opensource.org/codeofconduct)
49
+
-[Apache Code of Conduct](https://www.apache.org/foundation/policies/conduct.html)
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+17-10Lines changed: 17 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
Hello! Thank you for choosing to help contribute to one of the SendGrid open source libraries. There are many ways you can contribute and help is always welcome. We simply ask that you follow the following contribution policies.
1
+
Hello! Thank you for choosing to help contribute to one of the SendGrid open source libraries. There are many ways you can contribute and help is always welcome. We simply ask that you follow the following contribution policies.
2
2
3
3
-[CLAs and CCLAs](#cla)
4
4
-[Roadmap & Milestones](#roadmap)
@@ -11,14 +11,15 @@ Hello! Thank you for choosing to help contribute to one of the SendGrid open sou
11
11
-[Creating a Pull Request](#creating-a-pull-request)
12
12
13
13
<aname="roadmap"></a>
14
-
We use [Milestones](https://github.com/sendgrid/smtpapi-nodejs/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.
14
+
We use [Milestones](https://github.com/sendgrid/smtpapi-nodejs/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.
15
15
16
16
<aname="cla"></a>
17
+
17
18
## CLAs and CCLAs
18
19
19
20
Before you get started, SendGrid requires that a SendGrid Contributor License Agreement (CLA) be filled out by every contributor to a SendGrid open source project.
20
21
21
-
Our goal with the CLA is to clarify the rights of our contributors and reduce other risks arising from inappropriate contributions. The CLA also clarifies the rights SendGrid holds in each contribution and helps to avoid misunderstandings over what rights each contributor is required to grant to SendGrid when making a contribution. In this way the CLA encourages broad participation by our open source community and helps us build strong open source projects, free from any individual contributor withholding or revoking rights to any contribution.
22
+
Our goal with the CLA is to clarify the rights of our contributors and reduce other risks arising from inappropriate contributions. The CLA also clarifies the rights SendGrid holds in each contribution and helps to avoid misunderstandings over what rights each contributor is required to grant to SendGrid when making a contribution. In this way, the CLA encourages broad participation by our open source community and helps us build strong open source projects, free from any individual contributor withholding or revoking rights to any contribution.
22
23
23
24
SendGrid does not merge a pull request made against a SendGrid open source project until that pull request is associated with a signed CLA. Copies of the CLA are available [here](https://gist.github.com/SendGridDX/98b42c0a5d500058357b80278fde3be8#file-sendgrid_cla).
24
25
@@ -27,6 +28,7 @@ When you create a Pull Request, after a few seconds, a comment will appear with
27
28
There are a few ways to contribute, which we'll enumerate below:
28
29
29
30
<aname="feature-request"></a>
31
+
30
32
## Feature Request
31
33
32
34
If you'd like to make a feature request, please read this section.
@@ -37,6 +39,7 @@ The GitHub issue tracker is the preferred channel for library feature requests,
37
39
- Please be respectful and considerate of others when commenting on issues
38
40
39
41
<aname="submit-a-bug-report"></a>
42
+
40
43
## Submit a Bug Report
41
44
42
45
Note: DO NOT include your credentials in ANY code examples, descriptions, or media you make public.
@@ -46,29 +49,30 @@ A software bug is a demonstrable issue in the code base. In order for us to diag
46
49
Before you decide to create a new issue, please try the following:
47
50
48
51
1. Check the Github issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
49
-
2. Update to the latest version of this code and check if issue has already been fixed
52
+
2. Update to the latest version of this code and check if the issue has already been fixed
50
53
3. Copy and fill in the Bug Report Template we have provided below
51
54
52
55
### Please use our Bug Report Template
53
56
54
57
In order to make the process easier, we've included a [sample bug report template](https://github.com/sendgrid/smtpapi-nodejs/.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
58
56
59
<aname="improvements-to-the-codebase"></a>
60
+
57
61
## Improvements to the Codebase
58
62
59
63
We welcome direct contributions to the smtpapi-nodejs code base. Thank you!
60
64
61
-
### Development Environment ###
65
+
### Development Environment
62
66
63
-
#### Install and Run Locally ####
67
+
#### Install and Run Locally
64
68
65
-
##### Prerequisites #####
69
+
##### Prerequisites
66
70
67
71
- Node.js version 0.10, 0.12 or 4
68
72
- The SendGrid Service, starting at the [free level](https://sendgrid.com/free?source=smtpapi-nodejs)
69
73
- Please see [package.json](https://github.com/sendgrid/smtpapi-nodejs/blob/master/package.json)
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.
@@ -190,6 +197,6 @@ Please run your code through:
190
197
```
191
198
192
199
7.[Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
193
-
with a clear title and description against the `master` branch. All tests must be passing before we will review the PR.
200
+
with a clear title and description against the `master` branch. All tests must be passing before we will review the PR.
194
201
195
202
If you have any additional questions, please feel free to [email](mailto:dx@sendgrid.com) us or create an issue in this repo.
The following recommended installation requires [npm](https://npmjs.org/). If you are unfamiliar with npm, see the [npm docs](https://npmjs.org/doc/). Npm comes installed with Node.js since node version 0.8.x therefore you likely already have it.
46
+
The following recommended installation requires [npm](https://npmjs.org/). If you are unfamiliar with npm, see the [npm docs](https://npmjs.org/doc/). Npm comes installed with Node.js since node version 0.8.x, therefore, you likely already have it.
45
47
46
48
Add the following to your `package.json` file:
47
49
@@ -66,25 +68,29 @@ npm install
66
68
- Please see [package.json](https://github.com/sendgrid/smtpapi-nodejs/blob/master/package.json)
67
69
68
70
<aname="quick-start"></a>
71
+
69
72
# Quick Start
70
73
71
74
```javascript
72
-
var smtpapi =require('smtpapi');
73
-
var header =newsmtpapi();
74
-
header.addTo('test@example.com');
75
-
header.setUniqueArgs({cow:'chicken'});
75
+
var smtpapi =require("smtpapi");
76
+
var header =newsmtpapi();
77
+
header.addTo("test@example.com");
78
+
header.setUniqueArgs({cow:"chicken"});
76
79
console.log(header.jsonString());
77
80
```
78
81
79
82
<aname="usage"></a>
83
+
80
84
# Usage
81
85
82
86
<aname="roadmap"></a>
87
+
83
88
# Roadmap
84
89
85
90
If you are interested in the future direction of this project, please take a look at our [milestones](https://github.com/sendgrid/smtpapi-nodejs/milestones). We would love to hear your feedback.
86
91
87
92
<aname="contribute"></a>
93
+
88
94
# How to Contribute
89
95
90
96
We encourage contribution to our projects, please see our [CONTRIBUTING](https://github.com/sendgrid/smtpapi-nodejs/blob/master/CONTRIBUTING.md) guide for details.
@@ -97,12 +103,15 @@ Quick links:
97
103
-[Improvements to the Codebase](https://github.com/sendgrid/smtpapi-nodejs/blob/master/CONTRIBUTING.md#improvements-to-the-codebase)
98
104
99
105
<aname="about"></a>
106
+
100
107
# About
101
108
102
109
smtpapi-nodejs is guided and supported by the SendGrid [Developer Experience Team](mailto:dx@sendgrid.com).
103
110
104
111
smtpapi-nodejs is maintained and funded by SendGrid, Inc. The names and logos for smtpapi-nodejs are trademarks of SendGrid, Inc.
Copy file name to clipboardExpand all lines: TROUBLESHOOTING.md
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,19 +2,21 @@ If you have a non-library SendGrid issue, please contact our [support team](http
2
2
3
3
If you can't find a solution below, please open an [issue](https://github.com/sendgrid/sendgrid-nodejs/issues).
4
4
5
-
6
5
## Table of Contents
7
6
8
-
*[Versions](#versions)
9
-
*[Using the Package Manager](#package-manager)
10
-
*[Viewing the Request Body](#stmpapi-header)
7
+
-[Table of Contents](#table-of-contents)
8
+
-[Versions](#versions)
9
+
-[Using the Package Manager](#using-the-package-manager)
10
+
-[Outputting the STMPAPI Header](#outputting-the-stmpapi-header)
11
11
12
12
<aname="versions"></a>
13
+
13
14
## Versions
14
15
15
-
We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with to your code and never auto-update to the latest version. Especially when there is a MAJOR point release, since that is guaranteed to be a breaking change. Changes are documented in the [CHANGELOG](https://github.com/sendgrid/smtpapi-nodejs/blob/master/CHANGELOG.md) section.
16
+
We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with to your code and never auto-update to the latest version. Especially when there is a MAJOR point release since that is guaranteed to be a breaking change. Changes are documented in the [CHANGELOG](https://github.com/sendgrid/smtpapi-nodejs/blob/master/CHANGELOG.md) section.
16
17
17
18
<aname="package-manager"></a>
19
+
18
20
## Using the Package Manager
19
21
20
22
We upload this library to [npm](https://www.npmjs.com/package/sendgrid) whenever we make a release. This allows you to use [npm](https://www.npmjs.com) for easy installation.
@@ -38,6 +40,7 @@ If you are using a `package.json` file:
38
40
```
39
41
40
42
<aname="stmpapi-header"></a>
43
+
41
44
## Outputting the STMPAPI Header
42
45
43
46
You can output the header by the following:
@@ -57,4 +60,4 @@ or use it in your options for the transport (Nodemailer example):
If you would like to auto-generate documentation of the packages, you can do so locally by running:
4
+
4
5
```
5
6
./node_modules/.bin/esdoc
6
7
```
8
+
7
9
Using the .esdoc.json file, esdoc will create documentation in the docs directory.
8
10
9
11
## Checking docs coverage
10
12
11
13
You will find a coverage.json file in the docs directory. This will contain information about the documentation coverage for each of the different files in this repo.
0 commit comments