Skip to content

Commit aab1284

Browse files
chore: update GitHub branch references to use HEAD (#145)
1 parent 1f3769c commit aab1284

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

CONTRIBUTING.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ source ./sendgrid.env
7373

7474
##### Execute: #####
7575

76-
See the [examples folder](https://github.com/sendgrid/php-http-client/tree/master/examples).
76+
See the [examples folder](examples).
7777

7878
<a name="understanding-the-codebase"></a>
7979
## Understanding the Code Base
@@ -88,11 +88,11 @@ Unit tests.
8888

8989
**/lib/SendGrid/Client.php**
9090

91-
An HTTP client with a fluent interface using method chaining and reflection. By returning self on [__call](https://github.com/sendgrid/php-http-client/blob/master/lib/client.php#L212) and [_()](https://github.com/sendgrid/php-http-client/blob/master/lib/client.pph#L198), we can dynamically build the URL using method chaining and [__call](https://github.com/sendgrid/php-http-client/blob/master/lib/client.php#L212) allows us to dynamically receive the method calls to achieve reflection.
91+
An HTTP client with a fluent interface using method chaining and reflection. By returning `$this` on [__call](lib/Client.php#L576), we can dynamically build the URL using method chaining and [__call](lib/Client.php#L576) allows us to dynamically receive the method calls to achieve reflection.
9292

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

95-
`/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/php-http-client/blob/master/lib/client.php#L94).
95+
`/api_client/{api_key_id}/version` maps to `client->api_client().->_($api_key_id)->version-><method>()` where <method> is a [HTTP verb](lib/Client.php#L210).
9696

9797
**/lib/SendGrid/Config.php**
9898

@@ -103,9 +103,9 @@ Loads the environment variables.
103103

104104
All PRs require passing tests before the PR will be reviewed.
105105

106-
All test files are in the [`/test/unit`](https://github.com/sendgrid/php-http-client/tree/master/test/unit) directory.
106+
All test files are in the [`/test/unit`](test/unit) directory.
107107

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

110110
```bash
111111
composer install
@@ -166,7 +166,7 @@ Please run your code through:
166166
5. Locally merge (or rebase) the upstream development branch into your topic branch:
167167

168168
```bash
169-
git pull [--rebase] upstream master
169+
git pull [--rebase] upstream main
170170
```
171171

172172
6. Push your topic branch up to your fork:
@@ -176,7 +176,7 @@ Please run your code through:
176176
```
177177

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

181181
<a name="code-reviews"></a>
182182
## Code Reviews

README.md

+8-8
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-
[![Travis Badge](https://travis-ci.org/sendgrid/php-http-client.svg?branch=master)](https://travis-ci.org/sendgrid/php-http-client)
3+
[![Travis Badge](https://travis-ci.org/sendgrid/php-http-client.svg?branch=main)](https://travis-ci.org/sendgrid/php-http-client)
44
[![Latest Version on Packagist](https://img.shields.io/packagist/v/sendgrid/php-http-client.svg?style=flat-square)](https://packagist.org/packages/sendgrid/php-http-client)
55
[![Email Notifications Badge](https://dx.sendgrid.com/badge/php)](https://dx.sendgrid.com/newsletter/php)
66
[![Twitter Follow](https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow)](https://twitter.com/sendgrid)
@@ -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/php-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)
@@ -172,14 +172,14 @@ If you are interested in the future direction of this project, please take a loo
172172
<a name="contribute"></a>
173173
# How to Contribute
174174

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

177177
Quick links:
178178

179-
- [Feature Request](https://github.com/sendgrid/php-http-client/blob/master/CONTRIBUTING.md#feature-request)
180-
- [Bug Reports](https://github.com/sendgrid/php-http-client/blob/master/CONTRIBUTING.md#submit-a-bug-report)
181-
- [Improvements to the Codebase](https://github.com/sendgrid/php-http-client/blob/master/CONTRIBUTING.md#improvements-to-the-codebase)
182-
- [Review Pull Requests](https://github.com/sendgrid/php-http-client/blob/master/CONTRIBUTING.md#code-reviews)
179+
- [Feature Request](CONTRIBUTING.md#feature-request)
180+
- [Bug Reports](CONTRIBUTING.md#submit-a-bug-report)
181+
- [Improvements to the Codebase](CONTRIBUTING.md#improvements-to-the-codebase)
182+
- [Review Pull Requests](CONTRIBUTING.md#code-reviews)
183183

184184
<a name="thanks"></a>
185185
# Thanks

twilio_sendgrid_logo.png

14.3 KB
Loading

0 commit comments

Comments
 (0)