diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0d824ee..38e9c3d 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/ruby-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. @@ -190,3 +191,8 @@ Please run your code through: with a clear title and description against the `development` 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. \ No newline at end of file diff --git a/README.md b/README.md index 310c872..e32de1f 100644 --- a/README.md +++ b/README.md @@ -102,6 +102,7 @@ Quick links: - [Bug Reports](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#submit-a-bug-report) - [Sign the CLA to Create a Pull Request](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md) - [Improvements to the Codebase](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#improvements-to-the-codebase) +- [Review Pull Requests](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#code-reviews) # About diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md index 20d6d4d..be6a3a1 100644 --- a/TROUBLESHOOTING.md +++ b/TROUBLESHOOTING.md @@ -8,7 +8,7 @@ If you can't find a solution below, please open an [issue](https://github.com/se ## Viewing the Request Body -When debugging or testing, it may be useful to exampine the raw request body to compare against the [documented format](https://sendgrid.com/docs/API_Reference/api_v3.html). +When debugging or testing, it may be useful to examine the raw request body to compare against the [documented format](https://sendgrid.com/docs/API_Reference/api_v3.html). You can do this right before you call: `response = client.version('v3').api_keys.post(request_body: request_body)` like so: diff --git a/first-timers.md b/first-timers.md index 698ec2f..7a0e5d0 100644 --- a/first-timers.md +++ b/first-timers.md @@ -35,7 +35,7 @@ We label our issues according to their difficulty level. You can find easy ones git pull upstream ``` -3. Create a new topic branch (off the main project development branch) to +3. Create a new topic branch (off of the main project development branch) to contain your feature, change, or fix: ```bash