diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d2ea30d..20304c1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,6 +9,7 @@ Hello! Thank you for choosing to help contribute to one of the SendGrid open sou - [Testing](#testing) - [Style Guidelines & Naming Conventions](#style-guidelines-and-naming-conventions) - [Creating a Pull Request](#creating-a-pull-request) +- [Code Reviews](#code-reviews) We use [Milestones](https://github.com/sendgrid/nodemailer-sendgrid-transport/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. @@ -186,3 +187,8 @@ Please run your code through: with a clear title and description against the `master` branch. All tests must be passing before we will review the PR. If you have any additional questions, please feel free to [email](mailto:dx@sendgrid.com) us or create an issue in this repo. + + +## Code Reviews + +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/). diff --git a/README.md b/README.md index 8af1563..91becb3 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ This module is a transport plugin for [Nodemailer](https://github.com/andris9/No ## Table of Contents - [Usage](#usage) +- [How to Contribute](#contribute) - [Deploying](#deploying) - [License](#license) @@ -25,6 +26,19 @@ This module is a transport plugin for [Nodemailer](https://github.com/andris9/No ## Usage [Library Usage Documentation](USAGE.md) + +# How to Contribute + +We encourage contribution to our libraries, please see our [CONTRIBUTING](https://github.com/sendgrid/nodemailer-sendgrid-transport/blob/master/CONTRIBUTING.md) guide for details. + +Quick links: + +- [Feature Request](https://github.com/sendgrid/nodemailer-sendgrid-transport/blob/master/CONTRIBUTING.md#feature-request) +- [Bug Reports](https://github.com/sendgrid/nodemailer-sendgrid-transport/blob/master/CONTRIBUTING.md#submit-a-bug-report) +- [Sign the CLA to Create a Pull Request](https://github.com/sendgrid/nodemailer-sendgrid-transport/blob/master/CONTRIBUTING.md) +- [Improvements to the Codebase](https://github.com/sendgrid/nodemailer-sendgrid-transport/blob/master/CONTRIBUTING.md#improvements-to-the-codebase) +- [Review Pull Requests](https://github.com/sendgrid/nodemailer-sendgrid-transport/blob/master/CONTRIBUTING.md#code-reviews) + ## License [The MIT License (MIT)](LICENSE.txt)