Skip to content

Commit

Permalink
docs: Add pull request info to CONTRIBUTING and README (#61)
Browse files Browse the repository at this point in the history
  • Loading branch information
shorrock authored Sep 21, 2020
1 parent 8dfb657 commit d067a27
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Hello! Thank you for choosing to help contribute to one of the Twilio SendGrid o
- [Testing](#testing)
- [Style Guidelines & Naming Conventions](#style-guidelines-and-naming-conventions)
- [Creating a Pull Request](#creating-a-pull-request)
- [Code Reviews](#code-reviews)

<a name="feature-request"></a>
## Feature Request
Expand Down Expand Up @@ -155,3 +156,9 @@ Please run your code through:

7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
with a clear title and description against the `development` branch. All tests must be passing before we will review the PR.

## 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/).
2 changes: 2 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ Quick links:
- `Feature Request`_
- `Bug Reports`_
- `Improvements to the Codebase`_
- `Review Pull Requests`_

Local Setup of the Project
==========================
Expand Down Expand Up @@ -117,6 +118,7 @@ License
.. _Feature Request: https://github.com/sendgrid/smtpapi-python/blob/HEAD/CONTRIBUTING.md#feature-request
.. _Bug Reports: https://github.com/sendgrid/smtpapi-python/blob/HEAD/CONTRIBUTING.md#submit-a-bug-report
.. _Improvements to the Codebase: https://github.com/sendgrid/smtpapi-python/blob/HEAD/CONTRIBUTING.md#improvements-to-the-codebase
.. _Review Pull Requests: https://github.com/sendgrid/smtpapi-python/blob/HEAD/CONTRIBUTING.md#code-reviews)
.. _The MIT License (MIT): https://github.com/sendgrid/smtpapi-python/blob/HEAD/LICENSE.md

.. |Travis Badge| image:: https://travis-ci.org/sendgrid/smtpapi-python.svg?branch=main
Expand Down

0 comments on commit d067a27

Please sign in to comment.