Skip to content

Commit b2a4c91

Browse files
authored
docs: run .md files through grammarly (#111)
1 parent 8b303f0 commit b2a4c91

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

CONTRIBUTING.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
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.
1+
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 merely ask that you follow the following contribution policies.
22

33
- [CLAs and CCLAs](#cla)
44
- [Roadmap & Milestones](#roadmap)
@@ -12,14 +12,14 @@ Hello! Thank you for choosing to help contribute to one of the SendGrid open sou
1212
- [Code Reviews](#code-reviews)
1313

1414
<a name="roadmap"></a>
15-
We use [Milestones](https://github.com./sendgrid/php-http-client/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+
We use [Milestones](https://github.com./sendgrid/php-http-client/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.
1616

1717
<a name="cla"></a>
1818
## CLAs and CCLAs
1919

2020
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.
2121

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+
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 contributing. 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.
2323

2424
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).
2525

@@ -34,25 +34,25 @@ If you'd like to make a feature request, please read this section.
3434

3535
The GitHub issue tracker is the preferred channel for library feature requests, but please respect the following restrictions:
3636

37-
- Please **search for existing issues** in order to ensure we don't have duplicate bugs/feature requests.
37+
- Please **search for existing issues** to ensure we don't have duplicate bugs/feature requests.
3838
- Please be respectful and considerate of others when commenting on issues
3939

4040
<a name="submit-a-bug-report"></a>
4141
## Submit a Bug Report
4242

4343
Note: DO NOT include your credentials in ANY code examples, descriptions, or media you make public.
4444

45-
A software bug is a demonstrable issue in the code base. In order for us to diagnose the issue and respond as quickly as possible, please add as much detail as possible into your bug report.
45+
A software bug is a demonstrable issue in the code base. For us to diagnose the issue and respond as quickly as possible, please add as much detail as possible into your bug report.
4646

4747
Before you decide to create a new issue, please try the following:
4848

4949
1. Check the Github issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
50-
2. Update to the latest version of this code and check if issue has already been fixed
50+
2. Update to the latest version of this code and check if the issue has already been fixed
5151
3. Copy and fill in the Bug Report Template we have provided below
5252

5353
### Please use our Bug Report Template
5454

55-
In order to make the process easier, we've included a [sample bug report template](https://github.com./sendgrid/php-http-client/ISSUE_TEMPLATE.md) (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+
To make the process easier, we've included a [sample bug report template](https://github.com./sendgrid/php-http-client/ISSUE_TEMPLATE.md) (borrowed from [Ghost](https://github.com./TryGhost/Ghost/)). The template uses [GitHub flavored markdown](https://help.github.com./articles/github-flavored-markdown/) for formatting.
5656

5757
<a name="improvements-to-the-codebase"></a>
5858
## Improvements to the Codebase

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ composer install
5858

5959
## Install without Composer
6060

61-
You should create directory `lib` in directory of your application and clone to `lib` repositories [php-http-client](https://github.com./sendgrid/php-http-client.git) and [sendgrid-php](https://github.com./sendgrid/sendgrid-php.git):
61+
You should create a `lib` directory in the directory of your application and clone to `lib` repositories [php-http-client](https://github.com./sendgrid/php-http-client.git) and [sendgrid-php](https://github.com./sendgrid/sendgrid-php.git):
6262

6363
```
6464
$ cd /path/to/your/app
@@ -74,7 +74,7 @@ $ cd /path/to/your/app
7474
$ touch loader.php
7575
```
7676

77-
And add to `loader.php` code below:
77+
And add the code below to the `loader.php`:
7878

7979
```php
8080
<?php
@@ -83,7 +83,7 @@ require_once __DIR__ . '/lib/php-http-client/lib/Client.php';
8383
require_once __DIR__ . '/lib/php-http-client/lib/Response.php';
8484
```
8585

86-
After it you can use `php-http-client` library in your project:
86+
After it you can use the `php-http-client` library in your project:
8787

8888
```php
8989
<?php

TROUBLESHOOTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ If you can't find a solution below, please open an [issue](https://github.com./se
77
<a name="request-body"></a>
88
## Viewing the Request Body
99

10-
When debugging or testing, it may be useful to examine the raw request body. In the `examples/example.php` file, after your API call use this code to echo out the statuscode, body and headers:
10+
When debugging or testing, it may be useful to examine the raw request body. In the `examples/example.php` file, after your API call, use this code to echo out the status code, body, and headers:
1111

1212
```php
1313
echo $response->statusCode();

0 commit comments

Comments
 (0)