diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 72c76f5..7fbea69 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,8 @@ Hello! Thank you for choosing to help contribute to one of the SendGrid open sou - [Style Guidelines & Naming Conventions](#style-guidelines-and-naming-conventions) - [Creating a Pull Request](#creating-a-pull-request) -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. + +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. ## Feature Request @@ -30,7 +31,7 @@ A software bug is a demonstrable issue in the code base. In order for us to diag Before you decide to create a new issue, please try the following: 1. Check the Github issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post. -2. Update to the latest version of this code and check if issue has already been fixed +2. Update to the latest version of this code and check if the issue has already been fixed 3. Copy and fill in the Bug Report Template we have provided below ### Please use our Bug Report Template @@ -135,7 +136,7 @@ Please run your code through: 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. diff --git a/README.rst b/README.rst index 5157f89..c3de41f 100644 --- a/README.rst +++ b/README.rst @@ -96,11 +96,11 @@ Quick links: Local Setup of the Project ========================== -The simplest local development workflow is by using docker. +The simplest local development workflow is by using Docker. Steps: -1. Install Docker +1. Install [Docker](https://www.docker.com/) 2. Run ``docker-compose build`` (this builds the container) 3. Run ``docker-compose up`` (this runs tests by default)