Skip to content

Commit e4e3400

Browse files
authored
docs: Correct *.md files using Grammarly (#70)
1 parent 07ca62c commit e4e3400

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ Hello! Thank you for choosing to help contribute to one of the SendGrid open sou
88
- [Style Guidelines & Naming Conventions](#style-guidelines-and-naming-conventions)
99
- [Creating a Pull Request](#creating-a-pull-request)
1010

11-
We use [Milestones](https://github.com/sendgrid/smtpapi-python/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.
11+
<a name="roadmap"></a>
12+
We use [Milestones](https://github.com/sendgrid/smtpapi-python/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.
1213

1314
<a name="feature-request"></a>
1415
## Feature Request
@@ -30,7 +31,7 @@ A software bug is a demonstrable issue in the code base. In order for us to diag
3031
Before you decide to create a new issue, please try the following:
3132

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

3637
### Please use our Bug Report Template
@@ -135,7 +136,7 @@ Please run your code through:
135136

136137
4. Commit your changes in logical chunks. Please adhere to these [git commit
137138
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
138-
or your code is unlikely be merged into the main project. Use Git's
139+
or your code is unlikely to be merged into the main project. Use Git's
139140
[interactive rebase](https://help.github.com/articles/interactive-rebase)
140141
feature to tidy up your commits before making them public.
141142

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,11 +96,11 @@ Quick links:
9696
Local Setup of the Project
9797
==========================
9898

99-
The simplest local development workflow is by using docker.
99+
The simplest local development workflow is by using Docker.
100100

101101
Steps:
102102

103-
1. Install Docker
103+
1. Install [Docker](https://www.docker.com/)
104104
2. Run ``docker-compose build`` (this builds the container)
105105
3. Run ``docker-compose up`` (this runs tests by default)
106106

0 commit comments

Comments
 (0)