Skip to content

Commit 6846d4d

Browse files
authored
Merge branch 'master' into master
2 parents 90696d3 + df350d7 commit 6846d4d

File tree

2 files changed

+27
-15
lines changed

2 files changed

+27
-15
lines changed

CONTRIBUTING.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@ Hello! Thank you for choosing to help contribute to one of the SendGrid open sou
22

33
- [CLAs and CCLAs](#cla)
44
- [Roadmap & Milestones](#roadmap)
5-
- [Feature Request](#feature_request)
6-
- [Submit a Bug Report](#submit_a_bug_report)
7-
- [Improvements to the Codebase](#improvements_to_the_codebase)
8-
- [Understanding the Code Base](#understanding_the_codebase)
5+
- [Feature Request](#feature-request)
6+
- [Submit a Bug Report](#submit-a-bug-report)
7+
- [Improvements to the Codebase](#improvements-to-the-codebase)
8+
- [Understanding the Code Base](#understanding-the-codebase)
99
- [Testing](#testing)
10-
- [Style Guidelines & Naming Conventions](#style_guidelines_and_naming_conventions)
11-
- [Creating a Pull Request](#creating_a_pull_request)
10+
- [Style Guidelines & Naming Conventions](#style-guidelines-and-naming-conventions)
11+
- [Creating a Pull Request](#creating-a-pull-request)
1212

1313
<a name="roadmap"></a>
1414
We use [Milestones](https://github.com./sendgrid/php-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.
@@ -26,7 +26,7 @@ When you create a Pull Request, after a few seconds, a comment will appear with
2626

2727
There are a few ways to contribute, which we'll enumerate below:
2828

29-
<a name="feature_request"></a>
29+
<a name="feature-request"></a>
3030
## Feature Request
3131

3232
If you'd like to make a feature request, please read this section.
@@ -36,7 +36,7 @@ The GitHub issue tracker is the preferred channel for library feature requests,
3636
- Please **search for existing issues** in order to ensure we don't have duplicate bugs/feature requests.
3737
- Please be respectful and considerate of others when commenting on issues
3838

39-
<a name="submit_a_bug_report"></a>
39+
<a name="submit-a-bug-report"></a>
4040
## Submit a Bug Report
4141

4242
Note: DO NOT include your credentials in ANY code examples, descriptions, or media you make public.
@@ -53,7 +53,7 @@ Before you decide to create a new issue, please try the following:
5353

5454
In order to make the process easier, we've included a [sample bug report template](https://github.com./sendgrid/php-http-client/.github/ISSUE_TEMPLATE) (borrowed from [Ghost](https://github.com./TryGhost/Ghost/)). The template uses [GitHub flavored markdown](https://help.github.com./articles/github-flavored-markdown/) for formatting.
5555

56-
<a name="improvements_to_the_codebase"></a>
56+
<a name="improvements-to-the-codebase"></a>
5757
## Improvements to the Codebase
5858

5959
We welcome direct contributions to the php-http-client code base. Thank you!
@@ -89,7 +89,7 @@ source ./sendgrid.env
8989
##### Execute: #####
9090

9191
See the [examples folder](https://github.com./sendgrid/php-http-client/tree/master/examples
92-
<a name="understanding_the_codebase"></a>
92+
<a name="understanding-the-codebase"></a>
9393
## Understanding the Code Base
9494

9595
**/examples**
@@ -127,7 +127,7 @@ cd test/unit
127127
../../vendor/bin/phpunit . --bootstrap bootstrap.php --filter test*
128128
```
129129

130-
<a name="style_guidelines_and_naming_conventions"></a>
130+
<a name="style-guidelines-and-naming-conventions"></a>
131131
## Style Guidelines & Naming Conventions
132132

133133
Generally, we follow the style guidelines as suggested by the official language. However, we ask that you conform to the styles that already exist in the library. If you wish to deviate, please explain your reasoning.
@@ -138,7 +138,7 @@ Please run your code through:
138138

139139
- [PHP Code Sniffer](https://github.com./squizlabs/PHP_CodeSniffer)
140140

141-
## Creating a Pull Request<a name="creating_a_pull_request"></a>
141+
## Creating a Pull Request<a name="creating-a-pull-request"></a>
142142

143143
1. [Fork](https://help.github.com./fork-a-repo/) the project, clone your fork,
144144
and configure the remotes:

README.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@ If you are looking for the SendGrid API client library, please see [this repo](h
1313

1414
All updates to this library is documented in our [CHANGELOG](https://github.com./sendgrid/php-http-client/blob/master/CHANGELOG.md).
1515

16+
# Table of Contents
17+
- [Installation](#installation)
18+
- [Quick Start](#quick-start)
19+
- [Usage](#usage)
20+
- [Thanks](#thanks)
21+
- [About](#about)
22+
23+
<a name="installation"></a>
1624
# Installation
1725

1826
## Prerequisites
@@ -83,6 +91,7 @@ include __DIR__ . '/loader.php';
8391
$client = new SendGrid\Client();
8492
```
8593

94+
<a name="quick-start"></a>
8695
# Quick Start
8796

8897
Here is a quick example:
@@ -118,6 +127,7 @@ print $response->headers();
118127
print $response->body();
119128
```
120129

130+
<a name="usage"></a>
121131
# Usage
122132

123133
- [Example Code](https://github.com./sendgrid/php-http-client/tree/master/examples)
@@ -132,15 +142,17 @@ We encourage contribution to our libraries, please see our [CONTRIBUTING](https:
132142

133143
Quick links:
134144

135-
- [Feature Request](https://github.com./sendgrid/php-http-client/blob/master/CONTRIBUTING.md#feature_request)
136-
- [Bug Reports](https://github.com./sendgrid/php-http-client/blob/master/CONTRIBUTING.md#submit_a_bug_report)
145+
- [Feature Request](https://github.com./sendgrid/php-http-client/blob/master/CONTRIBUTING.md#feature-request)
146+
- [Bug Reports](https://github.com./sendgrid/php-http-client/blob/master/CONTRIBUTING.md#submit-a-bug-report)
137147
- [Sign the CLA to Create a Pull Request](https://github.com./sendgrid/php-http-client/blob/master/CONTRIBUTING.md#cla)
138-
- [Improvements to the Codebase](https://github.com./sendgrid/php-http-client/blob/master/CONTRIBUTING.md#improvements_to_the_codebase)
148+
- [Improvements to the Codebase](https://github.com./sendgrid/php-http-client/blob/master/CONTRIBUTING.md#improvements-to-the-codebase)
139149

150+
<a name="thanks"></a>
140151
# Thanks
141152

142153
We were inspired by the work done on [birdy](https://github.com./inueni/birdy) and [universalclient](https://github.com./dgreisen/universalclient).
143154

155+
<a name="about"></a>
144156
# About
145157

146158
php-http-client is guided and supported by the SendGrid [Developer Experience Team](mailto:[email protected]).

0 commit comments

Comments
 (0)