You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -73,7 +73,7 @@ source ./sendgrid.env
73
73
74
74
##### Execute: #####
75
75
76
-
See the [examples folder](https://github.com/sendgrid/php-http-client/tree/master/examples).
76
+
See the [examples folder](examples).
77
77
78
78
<aname="understanding-the-codebase"></a>
79
79
## Understanding the Code Base
@@ -88,11 +88,11 @@ Unit tests.
88
88
89
89
**/lib/SendGrid/Client.php**
90
90
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.
92
92
93
93
This allows for the following mapping from a URL to a method chain:
94
94
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).
96
96
97
97
**/lib/SendGrid/Config.php**
98
98
@@ -103,9 +103,9 @@ Loads the environment variables.
103
103
104
104
All PRs require passing tests before the PR will be reviewed.
105
105
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.
107
107
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.
109
109
110
110
```bash
111
111
composer install
@@ -166,7 +166,7 @@ Please run your code through:
166
166
5. Locally merge (or rebase) the upstream development branch into your topic branch:
167
167
168
168
```bash
169
-
git pull [--rebase] upstream master
169
+
git pull [--rebase] upstream main
170
170
```
171
171
172
172
6. Push your topic branch up to your fork:
@@ -176,7 +176,7 @@ Please run your code through:
176
176
```
177
177
178
178
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.
[](https://packagist.org/packages/sendgrid/php-http-client)
@@ -14,7 +14,7 @@ If you are looking for the SendGrid API client library, please see [this repo](h
14
14
# Announcements
15
15
**The default branch name for this repository has been changed to `main` as of 07/27/2020.**
16
16
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).
18
18
19
19
# Table of Contents
20
20
-[Installation](#installation)
@@ -172,14 +172,14 @@ If you are interested in the future direction of this project, please take a loo
172
172
<aname="contribute"></a>
173
173
# How to Contribute
174
174
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.
-[Improvements to the Codebase](https://github.com/sendgrid/php-http-client/blob/master/CONTRIBUTING.md#improvements-to-the-codebase)
0 commit comments