Skip to content

Commit b770cd5

Browse files
chore: update GitHub branch references to use HEAD (#120)
1 parent 0a2312a commit b770cd5

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed

CONTRIBUTING.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ source ./sendgrid.env
7272

7373
##### Execute: #####
7474

75-
See the [examples folder](https://github.com/sendgrid/ruby-http-client/tree/master/examples) to get started quickly.
75+
See the [examples folder](examples) to get started quickly.
7676

7777
To run the example (after updating the emails):
7878

@@ -89,20 +89,20 @@ Working examples that demonstrate usage.
8989

9090
**ruby_http_client.rb**
9191

92-
An HTTP client with a fluent interface using method chaining and reflection. By returning self on [method_missing](https://github.com/sendgrid/ruby-http-client/blob/master/lib/ruby_http_client.rb#L209) and [_()](https://github.com/sendgrid/ruby-http-client/blob/master/lib/ruby_http_client.rb#L194), we can dynamically build the URL using method chaining and [method_missing](https://github.com/sendgrid/ruby-http-client/blob/master/lib/ruby_http_client.rb#L209) allows us to dynamically receive the method calls to achieve reflection.
92+
An HTTP client with a fluent interface using method chaining and reflection. By returning self on [method_missing](lib/ruby_http_client.rb#L209) and [_()](lib/ruby_http_client.rb#L194), we can dynamically build the URL using method chaining and [method_missing](lib/ruby_http_client.rb#L209) allows us to dynamically receive the method calls to achieve reflection.
9393

9494
This allows for the following mapping from a URL to a method chain:
9595

96-
`/api_client/{api_key_id}/version` maps to `client.api_client._(api_key_id).version.<method>()` where <method> is a [HTTP verb](https://github.com/sendgrid/ruby-http-client/blob/master/lib/ruby_http_client.rb#L38).
96+
`/api_client/{api_key_id}/version` maps to `client.api_client._(api_key_id).version.<method>()` where <method> is a [HTTP verb](lib/ruby_http_client.rb#L38).
9797

9898
<a name="testing"></a>
9999
## Testing
100100

101101
All PRs require passing tests before the PR will be reviewed.
102102

103-
All test files are in the [`test`](https://github.com/sendgrid/ruby-http-client/tree/master/test) directory.
103+
All test files are in the [`test`](test) directory.
104104

105-
For the purposes of contributing to this repo, please update the [`test_ruby_http_client.rb`](https://github.com/sendgrid/ruby-http-client/blob/master/test/test_ruby_http_client.rb) file with unit tests as you modify the code.
105+
For the purposes of contributing to this repo, please update the [`test_ruby_http_client.rb`](test/test_ruby_http_client.rb) file with unit tests as you modify the code.
106106

107107
To run the tests:
108108

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)
1+
![SendGrid Logo](twilio_sendgrid_logo.png)
22

3-
[![BuildStatus](https://travis-ci.org/sendgrid/ruby-http-client.svg?branch=master)](https://travis-ci.org/sendgrid/ruby-http-client)
3+
[![BuildStatus](https://travis-ci.org/sendgrid/ruby-http-client.svg?branch=main)](https://travis-ci.org/sendgrid/ruby-http-client)
44
[![Email Notifications Badge](https://dx.sendgrid.com/badge/ruby)](https://dx.sendgrid.com/newsletter/ruby)
55
[![Gem Version](https://badge.fury.io/rb/ruby_http_client.svg)](https://badge.fury.io/rb/ruby_http_client)
66
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md)
@@ -14,7 +14,7 @@ If you are looking for the SendGrid API client library, please see [this repo](h
1414
# Announcements
1515
**The default branch name for this repository has been changed to `main` as of 07/27/2020.**
1616

17-
All updates to this library are documented in our [CHANGELOG](https://github.com/sendgrid/ruby-http-client/blob/master/CHANGELOG.md).
17+
All updates to this library are documented in our [CHANGELOG](CHANGELOG.md).
1818

1919
# Table of Contents
2020
- [Installation](#installation)
@@ -85,7 +85,7 @@ puts response.headers
8585
<a name="usage"></a>
8686
# Usage
8787

88-
- [Example Code](https://github.com/sendgrid/ruby-http-client/tree/master/examples)
88+
- [Example Code](examples)
8989

9090
<a name="roadmap"></a>
9191
# Roadmap
@@ -95,14 +95,14 @@ If you are interested in the future direction of this project, please take a loo
9595
<a name="contribute"></a>
9696
# How to Contribute
9797

98-
We encourage contribution to our libraries, please see our [CONTRIBUTING](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md) guide for details.
98+
We encourage contribution to our libraries, please see our [CONTRIBUTING](CONTRIBUTING.md) guide for details.
9999

100100
Quick links:
101101

102-
- [Feature Request](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#feature-request)
103-
- [Bug Reports](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#submit-a-bug-report)
104-
- [Improvements to the Codebase](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#improvements-to-the-codebase)
105-
- [Review Pull Requests](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#code-reviews)
102+
- [Feature Request](CONTRIBUTING.md#feature-request)
103+
- [Bug Reports](CONTRIBUTING.md#submit-a-bug-report)
104+
- [Improvements to the Codebase](CONTRIBUTING.md#improvements-to-the-codebase)
105+
- [Review Pull Requests](CONTRIBUTING.md#code-reviews)
106106

107107
<a name="about"></a>
108108
# About

first-timers.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ We label our issues according to their difficulty level. You can find easy ones
5555
5. Locally merge (or rebase) the upstream development branch into your topic branch:
5656

5757
```bash
58-
git pull [--rebase] upstream master
58+
git pull [--rebase] upstream main
5959
```
6060

6161
6. Push your topic branch up to your fork:
@@ -65,4 +65,4 @@ We label our issues according to their difficulty level. You can find easy ones
6565
```
6666

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

twilio_sendgrid_logo.png

14.3 KB
Loading

0 commit comments

Comments
 (0)