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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+15-26Lines changed: 15 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ Before you decide to create a new issue, please try the following:
42
42
43
43
### Please use our Bug Report Template
44
44
45
-
In order to make the process easier, we've included a [sample bug report template](https://github.com/sendgrid/sendgrid-csharp/.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.
45
+
In order to make the process easier, we've included a [sample bug report template](ISSUE_TEMPLATE.md).
46
46
47
47
<aname="improvements-to-the-codebase"></a>
48
48
## Improvements to the Codebase
@@ -58,7 +58,7 @@ Please note that we utilize the [Gitflow Workflow](https://www.atlassian.com/git
58
58
##### Prerequisites #####
59
59
60
60
- .NET 4.5.2+
61
-
-[Visual Studio Community 2017](https://www.visualstudio.com/downloads/)+
61
+
-[Visual Studio Community 2017](https://www.visualstudio.com/downloads/)
62
62
63
63
##### Initial setup: #####
64
64
@@ -83,36 +83,25 @@ Next, update your Environment with your [SENDGRID_APIKEY](https://app.sendgrid.c
All PRs require passing tests before the PR will be reviewed.
110
-
111
-
All test files are in the [`SendGrid.Tests`](https://github.com/sendgrid/sendgrid-csharp/blob/master/tests/SendGrid.Tests) directory.
100
+
All PRs require passing tests before the PR will be reviewed. All test files are in the [`SendGrid.Tests`](https://github.com/sendgrid/sendgrid-csharp/blob/master/tests/SendGrid.Tests) directory. For the purposes of contributing to this repo, please update the [`Integration.cs`](https://github.com/sendgrid/sendgrid-csharp/blob/master/tests/SendGrid.Tests/Integration.cs) file with unit tests as you modify the code.
112
101
113
-
For the purposes of contributing to this repo, please update the [`Integration.cs`](https://github.com/sendgrid/sendgrid-csharp/blob/master/tests/SendGrid.Tests/Integration.cs) file with unit tests as you modify the code.
102
+
The integration tests require a Twilio SendGrid mock API in order to execute. We've simplified setting this up using Docker to run the tests. You will just need [Docker Desktop](https://docs.docker.com/get-docker/) and `make`.
114
103
115
-
The integration tests require a Twilio SendGrid mock API in order to execute. We've simplified setting this up using Docker to run the tests. You will just need [Docker Desktop](https://docs.docker.com/get-docker/) and `make`. Once these are available, simply run the Docker test target to run all tests: `make test-docker`
104
+
Once these are available, simply execute the Docker test target to run all tests: `make test-docker`. This command can also be used to open an interactive shell into the container where this library is installed. To start a *bash* shell for example, use this command: `command=bash make test-docker`.
0 commit comments