Skip to content

Commit 1f71f06

Browse files
Twilio branding updates, CLA updates
1 parent 341fc6c commit 1f71f06

23 files changed

Lines changed: 296 additions & 209 deletions

.github/PULL_REQUEST_TEMPLATE

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<!--
22
We appreciate the effort for this pull request but before that please make sure you read the contribution guidelines given above, then fill out the blanks below.
33

4+
**All third party contributors acknowledge that any contributions they provide will be made under the same open source license that the open source project is provided under.**
45

56
Please enter each Issue number you are resolving in your PR after one of the following words [Fixes, Closes, Resolves]. This will auto-link these issues and close them when this PR is merged!
67
e.g.
@@ -10,6 +11,7 @@ Closes #2
1011
# Fixes #
1112

1213
### Checklist
14+
- [ ] I acknowledge that all my contributions will be made under the project's license
1315
- [ ] I have made a material change to the repo (functionality, testing, spelling, grammar)
1416
- [ ] I have read the [Contribution Guide] and my PR follows them.
1517
- [ ] I updated my branch with the master branch.
@@ -21,4 +23,4 @@ Closes #2
2123
-
2224
-
2325

24-
If you have questions, please send an email to [Sendgrid](mailto:dx@sendgrid.com), or file a Github Issue in this repository.
26+
If you have questions, please send an email to [Twilio SendGrid](mailto:dx@sendgrid.com), or file a Github Issue in this repository.

CODE_OF_CONDUCT.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
1-
# SendGrid Community Code of Conduct
1+
# Twilio SendGrid Community Code of Conduct
22

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.
3+
The Twilio 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.
44

55
### Be Open
66
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.
77

88
### Be Considerate
9-
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.
9+
Members of the community are considerate of their peers, which include other contributors and users of Twilio 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.
1010

1111
### 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.
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 Twilio 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.
1313

1414
## Additional Guidance
1515

1616
### Disclose Potential Conflicts of Interest
1717
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.
1818

1919
### 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.
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 [Twilio SendGrid’s cultural values](https://sendgrid.com/blog/employee-engagement-the-4h-way) defined by our “4H’s”: Happy, Hungry, Humble and Honest.
2121

2222
### Enforcement
23-
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.
23+
Most members of the Twilio 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.
2424

2525
## If you have concerns about someone’s conduct
2626
**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.
2727

2828
**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.
2929

30-
**Contact the Moderators** - You can reach the SendGrid moderators by emailing dx@sendgrid.com.
30+
**Contact the Moderators** - You can reach the Twilio SendGrid moderators by emailing dx@sendgrid.com.
3131

32-
## 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).
32+
## Submission to Twilio SendGrid Repositories
33+
Finally, just a reminder, changes to the Twilio SendGrid repositories will only be accepted upon completion of the [Twilio SendGrid Contributor Agreement](https://cla.sendgrid.com).
3434

3535
## Attribution
3636

37-
SendGrid thanks the following, on which it draws for content and inspiration:
37+
Twilio SendGrid thanks the following, on which it draws for content and inspiration:
3838

3939
* [Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/)
4040
* [Open Source Initiative General Code of Conduct](https://opensource.org/codeofconduct)

CONTRIBUTING.md

Lines changed: 10 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
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 Twilio 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.
22

3-
- [CLAs and CCLAs](#clas-and-cclas)
3+
**All third party contributors acknowledge that any contributions they provide will be made under the same open source license that the open source project is provided under.**
44
- [Feature Request](#feature-request)
55
- [Submit a Bug Report](#submit-a-bug-report)
6-
- [Please use our Bug Report Template](#please-use-our-bug-report-template)
6+
- [Please use our Bug Report Template](#please-use-our-bug-report-template)
77
- [Improvements to the Codebase](#improvements-to-the-codebase)
8-
- [Development Environment](#development-environment)
9-
- [Install and Run Locally](#install-and-run-locally)
10-
- [Prerequisites](#prerequisites)
11-
- [Initial setup:](#initial-setup)
12-
- [Environment Variables](#environment-variables)
13-
- [Execute:](#execute)
8+
- [Development Environment](#development-environment)
9+
- [Install and Run Locally](#install-and-run-locally)
10+
- [Prerequisites](#prerequisites)
11+
- [Initial setup:](#initial-setup)
12+
- [Environment Variables](#environment-variables)
13+
- [Execute:](#execute)
1414
- [Understanding the Code Base](#understanding-the-code-base)
1515
- [Testing](#testing)
1616
- [Style Guidelines & Naming Conventions](#style-guidelines--naming-conventions)
@@ -20,17 +20,6 @@ Hello! Thank you for choosing to help contribute to one of the SendGrid open sou
2020
<a name="roadmap"></a>
2121
We use [Milestones](https://github.com/sendgrid/sendgrid-ruby/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.
2222

23-
<a name="cla"></a>
24-
## CLAs and CCLAs
25-
26-
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.
27-
28-
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.
29-
30-
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).
31-
32-
When you create a Pull Request, after a few seconds, a comment will appear with a link to the CLA. Click the link and fill out the brief form and then click the "I agree" button and you are all set. You will not be asked to re-sign the CLA unless we make a change.
33-
3423
There are a few ways to contribute, which we'll enumerate below:
3524

3625
<a name="feature-request"></a>
@@ -92,7 +81,7 @@ We welcome direct contributions to the sendgrid-ruby code base. Thank you!
9281

9382
### Environment Variables
9483

95-
First, get your free SendGrid account [here](https://sendgrid.com/free?source=sendgrid-ruby).
84+
First, get your free Twilio SendGrid account [here](https://sendgrid.com/free?source=sendgrid-ruby).
9685

9786
Next, update your environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys).
9887

LICENSE.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2014-2019 SendGrid, Inc.
1+
Copyright (c) 2014-2019 Twilio SendGrid, Inc.
22

33
MIT License
44

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)
1+
![Twilio SendGrid Logo](https://github.com/sendgrid/sendgrid-python/raw/master/twilio_sendgrid_logo.png)
22

33
[![Travis Badge](https://travis-ci.org/sendgrid/sendgrid-ruby.svg?branch=master)](https://travis-ci.org/sendgrid/sendgrid-ruby)
44
[![Gem Version](https://badge.fury.io/rb/sendgrid-ruby.svg)](https://badge.fury.io/rb/sendgrid-ruby)
@@ -10,11 +10,11 @@
1010

1111
**NEW:** Subscribe to email [notifications](https://dx.sendgrid.com/newsletter/ruby) for releases and breaking changes.
1212

13-
**This library allows you to quickly and easily use the SendGrid Web API v3 via Ruby.**
13+
**This library allows you to quickly and easily use the Twilio SendGrid Web API v3 via Ruby.**
1414

15-
Version 3.X.X+ of this library provides full support for all SendGrid [Web API v3](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) endpoints, including the new [v3 /mail/send](https://sendgrid.com/blog/introducing-v3mailsend-sendgrids-new-mail-endpoint).
15+
Version 3.X.X+ of this library provides full support for all Twilio SendGrid [Web API v3](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) endpoints, including the new [v3 /mail/send](https://sendgrid.com/blog/introducing-v3mailsend-sendgrids-new-mail-endpoint).
1616

17-
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-ruby/issues) and [pull requests](https://github.com/sendgrid/sendgrid-ruby/blob/master/CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests.
17+
This library represents the beginning of a new path for SendGrid. We want this library to be community driven and Twilio 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-ruby/issues) and [pull requests](https://github.com/sendgrid/sendgrid-ruby/blob/master/CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests.
1818

1919
Please browse the rest of this README for further details.
2020

@@ -47,7 +47,7 @@ We appreciate your continued support, thank you!
4747
## Prerequisites
4848

4949
- Ruby version >= 2.2 (except version [2.6.0](https://github.com/sendgrid/sendgrid-ruby/blob/master/TROUBLESHOOTING.md#ruby-versions))
50-
- The SendGrid service, starting at the [free level](https://sendgrid.com/free?source=sendgrid-ruby)
50+
- The Twilio SendGrid service, starting at the [free level](https://sendgrid.com/free?source=sendgrid-ruby)
5151

5252
## Setup Environment Variables
5353

@@ -97,7 +97,7 @@ include SendGrid
9797

9898
from = SendGrid::Email.new(email: 'test@example.com')
9999
to = SendGrid::Email.new(email: 'test@example.com')
100-
subject = 'Sending with SendGrid is Fun'
100+
subject = 'Sending with Twilio SendGrid is Fun'
101101
content = SendGrid::Content.new(type: 'text/plain', value: 'and easy to do anywhere, even with Ruby')
102102
mail = SendGrid::Mail.new(from, subject, to, content)
103103

@@ -127,7 +127,7 @@ data = JSON.parse('{
127127
"email": "test@example.com"
128128
}
129129
],
130-
"subject": "Sending with SendGrid is Fun"
130+
"subject": "Sending with Twilio SendGrid is Fun"
131131
}
132132
],
133133
"from": {
@@ -180,7 +180,7 @@ Please see [our helper](https://github.com/sendgrid/sendgrid-ruby/tree/master/li
180180
<a name="usage"></a>
181181
# Usage
182182

183-
- [SendGrid Docs](https://sendgrid.com/docs/API_Reference/index.html)
183+
- [Twilio SendGrid Docs](https://sendgrid.com/docs/API_Reference/index.html)
184184
- [Library Usage Docs](https://github.com/sendgrid/sendgrid-ruby/tree/master/USAGE.md)
185185
- [Example Code](https://github.com/sendgrid/sendgrid-ruby/tree/master/examples)
186186
- [How-to: Migration from v2 to v3](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html)
@@ -223,7 +223,7 @@ Please see our [troubleshooting guide](https://github.com/sendgrid/sendgrid-ruby
223223
<a name="about"></a>
224224
# About
225225

226-
sendgrid-ruby is guided and supported by the SendGrid [Developer Experience Team](mailto:dx@sendgrid.com).
226+
sendgrid-ruby is guided and supported by the [Developer Experience Team](mailto:dx@sendgrid.com).
227227

228228
sendgrid-ruby is maintained and funded by SendGrid, Inc. The names and logos for sendgrid-ruby are trademarks of SendGrid, Inc.
229229

TROUBLESHOOTING.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
1-
If you have a non-library SendGrid issue, please contact our [support team](https://support.sendgrid.com).
1+
If you have a non-library Twilio SendGrid issue, please contact our [support team](https://support.sendgrid.com).
22

33
If you can't find a solution below, please open an [issue](https://github.com/sendgrid/sendgrid-ruby/issues).
44

55

66
## Table of Contents
77

8-
* [Migrating from v2 to v3](#migrating)
9-
* [Continue Using v2](#v2)
10-
* [Testing v3 /mail/send Calls Directly](#testing)
11-
* [Error Messages](#error)
12-
* [Versioning](#versioning)
13-
* [Environment Variables and Your SendGrid API Key](#environment)
14-
* [Using the Package Manager](#package-manager)
15-
* [Rails Specifics](#rails-specifics)
16-
* [Ruby Versions](#ruby-versions)
17-
* [Viewing the Request Body](#request-body)
8+
- [Table of Contents](#table-of-contents)
9+
- [Migrating from v2 to v3](#migrating-from-v2-to-v3)
10+
- [Continue Using v2](#continue-using-v2)
11+
- [Testing v3 /mail/send Calls Directly](#testing-v3-mailsend-calls-directly)
12+
- [Error Messages](#error-messages)
13+
- [Versioning](#versioning)
14+
- [Environment Variables and Your Twilio SendGrid API Key](#environment-variables-and-your-twilio-sendgrid-api-key)
15+
- [Using the Package Manager](#using-the-package-manager)
16+
- [Rails Specifics](#rails-specifics)
17+
- [Ruby Versions](#ruby-versions)
18+
- [Viewing the Request Body](#viewing-the-request-body)
1819

1920
<a name="migrating"></a>
2021
## Migrating from v2 to v3
@@ -74,19 +75,19 @@ end
7475
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/sendgrid-ruby/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-ruby/releases) section.
7576

7677
<a name="environment"></a>
77-
## Environment Variables and Your SendGrid API Key
78+
## Environment Variables and Your Twilio SendGrid API Key
7879

79-
All of our examples assume you are using [environment variables](https://github.com/sendgrid/sendgrid-ruby#setup-environment-variables) to hold your SendGrid API key.
80+
All of our examples assume you are using [environment variables](https://github.com/sendgrid/sendgrid-ruby#setup-environment-variables) to hold your Twilio SendGrid API key.
8081

81-
If you choose to add your SendGrid API key directly (not recommended):
82+
If you choose to add your Twilio SendGrid API key directly (not recommended):
8283

8384
`sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY'])`
8485

8586
becomes
8687

8788
`sg = SendGrid::API.new(api_key: 'SENDGRID_API_KEY')`
8889

89-
In the first case SENDGRID_API_KEY is in reference to the name of the environment variable, while the second case references the actual SendGrid API Key.
90+
In the first case SENDGRID_API_KEY is in reference to the name of the environment variable, while the second case references the actual Twilio SendGrid API Key.
9091

9192
<a name="package-manager"></a>
9293
## Using the Package Manager

0 commit comments

Comments
 (0)