--- a/vendor/github.com/sendgrid/rest/CONTRIBUTING.md Mon Jun 07 20:58:18 2021 +0200
+++ b/vendor/github.com/sendgrid/rest/CONTRIBUTING.md Sun Jul 11 10:35:56 2021 +0200
@@ -1,7 +1,5 @@
Hello! Thank you for choosing to help contribute to one of the SendGrid open source projects. There are many ways you can contribute and help is always welcome. We simply ask that you follow the following contribution policies.
-- [CLAs and CCLAs](#cla)
-- [Roadmap & Milestones](#roadmap)
- [Feature Request](#feature-request)
- [Submit a Bug Report](#submit-a-bug-report)
- [Improvements to the Codebase](#improvements-to-the-codebase)
@@ -9,22 +7,7 @@
- [Testing](#testing)
- [Style Guidelines & Naming Conventions](#style-guidelines-and-naming-conventions)
- [Creating a Pull Request](#creating-a-pull-request)
-
-<a name="roadmap"></a>
-We use [Milestones](https://github.com/sendgrid/rest/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.
-
-<a name="cla"></a>
-## CLAs and CCLAs
-
-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.
-
-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.
-
-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).
-
-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.
-
-There are a few ways to contribute, which we'll enumerate below:
+- [Code Reviews](#code-reviews)
<a name="feature-request"></a>
## Feature Request
@@ -51,7 +34,7 @@
### Please use our Bug Report Template
-In order to make the process easier, we've included a [sample bug report template](https://github.com/sendgrid/rest/.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.
+In order to make the process easier, we've included a [sample bug report template](ISSUE_TEMPLATE.md).
<a name="improvements-to-the-codebase"></a>
## Improvements to the Codebase
@@ -73,15 +56,11 @@
cd rest
```
-##### Execute: #####
-
-See the [examples folder](https://github.com/sendgrid/rest/tree/master/examples) to get started quickly.
-
-If you want to try the SendGrid example:
+### Environment Variables
First, get your free SendGrid account [here](https://sendgrid.com/free?source=rest).
-You will need to setup the following environment to use the SendGrid example:
+Next, update your environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys) if you will test with Swift Mailer.
```
echo "export SENDGRID-API-KEY='YOUR-API-KEY'" > sendgrid.env
@@ -90,6 +69,10 @@
go run examples/example.go
```
+##### Execute: #####
+
+See the [examples folder](examples) to get started quickly.
+
<a name="understanding-the-codebase"></a>
## Understanding the Code Base
@@ -108,9 +91,9 @@
All PRs require passing tests before the PR will be reviewed.
-All test files are in [`rest-test.go`](https://github.com/sendgrid/rest/blob/master/rest_test.go).
+All test files are in [`rest-test.go`](rest_test.go).
-For the purposes of contributing to this repo, please update the [`rest-test.go`](https://github.com/sendgrid/rest/blob/master/rest_test.go) file with unit tests as you modify the code.
+For the purposes of contributing to this repo, please update the [`rest-test.go`](rest_test.go) file with unit tests as you modify the code.
Run the test:
@@ -146,11 +129,11 @@
2. If you cloned a while ago, get the latest changes from upstream:
```bash
- git checkout <dev-branch>
- git pull upstream <dev-branch>
+ git checkout development
+ git pull upstream development
```
-3. Create a new topic branch (off the main project development branch) to
+3. Create a new topic branch off the `development` branch to
contain your feature, change, or fix:
```bash
@@ -159,7 +142,7 @@
4. Commit your changes in logical chunks. Please adhere to these [git commit
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
- or your code is unlikely be merged into the main project. Use Git's
+ or your code is unlikely to be merged into the main project. Use Git's
[interactive rebase](https://help.github.com/articles/interactive-rebase)
feature to tidy up your commits before making them public.
@@ -170,7 +153,7 @@
5. Locally merge (or rebase) the upstream development branch into your topic branch:
```bash
- git pull [--rebase] upstream master
+ git pull [--rebase] upstream development
```
6. Push your topic branch up to your fork:
@@ -180,6 +163,7 @@
```
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
- with a clear title and description against the `master` branch. All tests must be passing before we will review the PR.
+ with a clear title and description against the `development` branch. All tests must be passing before we will review the PR.
-If you have any additional questions, please feel free to [email](mailto:dx@sendgrid.com) us or create an issue in this repo.
+## Code Reviews<a name="code-reviews"></a>
+If you can, please look at open PRs and review them. Give feedback and help us merge these PRs much faster! If you don't know how, Github has some great [information on how to review a Pull Request](https://help.github.com/articles/about-pull-request-reviews/).