Skip to content

Commit af86cc0

Browse files
authored
docs: Update docs to align with SendGrid Support (#154)
1 parent fbfc047 commit af86cc0

File tree

8 files changed

+6
-76
lines changed

8 files changed

+6
-76
lines changed

.github/ISSUE_TEMPLATE/config.yml

-10
This file was deleted.

CONTRIBUTING.md

-29
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,12 @@
11
Hello! Thank you for choosing to help contribute to one of the SendGrid open source projects. There are many ways you can contribute and help is always welcome. We merely ask that you follow the following contribution policies.
22

3-
- [Feature Request](#feature-request)
4-
- [Submit a Bug Report](#submit-a-bug-report)
53
- [Improvements to the Codebase](#improvements-to-the-codebase)
64
- [Understanding the Code Base](#understanding-the-codebase)
75
- [Testing](#testing)
86
- [Style Guidelines & Naming Conventions](#style-guidelines-and-naming-conventions)
97
- [Creating a Pull Request](#creating-a-pull-request)
108
- [Code Reviews](#code-reviews)
119

12-
<a name="feature-request"></a>
13-
## Feature Request
14-
15-
If you'd like to make a feature request, please read this section.
16-
17-
The GitHub issue tracker is the preferred channel for library feature requests, but please respect the following restrictions:
18-
19-
- Please **search for existing issues** to ensure we don't have duplicate bugs/feature requests.
20-
- Please be respectful and considerate of others when commenting on issues
21-
22-
<a name="submit-a-bug-report"></a>
23-
## Submit a Bug Report
24-
25-
Note: DO NOT include your credentials in ANY code examples, descriptions, or media you make public.
26-
27-
A software bug is a demonstrable issue in the code base. For us to diagnose the issue and respond as quickly as possible, please add as much detail as possible into your bug report.
28-
29-
Before you decide to create a new issue, please try the following:
30-
31-
1. Check the Github issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
32-
2. Update to the latest version of this code and check if the issue has already been fixed
33-
3. Copy and fill in the Bug Report Template we have provided below
34-
35-
### Please use our Bug Report Template
36-
37-
In order to make the process easier, we've included a [sample bug report template](ISSUE_TEMPLATE.md).
38-
3910
<a name="improvements-to-the-codebase"></a>
4011
## Improvements to the Codebase
4112

FIRST_TIMERS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# How To Contribute to Twilio SendGrid Repositories via GitHub
2-
Contributing to the Twilio SendGrid repositories is easy! All you need to do is find an open issue (see the bottom of this page for a list of repositories containing open issues), fix it and submit a pull request. Once you have submitted your pull request, the team can easily review it before it is merged into the repository.
2+
Contributing to the Twilio SendGrid repositories is easy! Once you have submitted your pull request, the team can easily review it before it is merged into the repository.
33

44
To make a pull request, follow these steps:
55

ISSUE_TEMPLATE.md

-30
This file was deleted.

PULL_REQUEST_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ A short description of what this PR does.
2828
- [ ] I have added the necessary documentation about the functionality in the appropriate .md file
2929
- [ ] I have added inline documentation to the code I modified
3030

31-
If you have questions, please file a [support ticket](https://support.sendgrid.com), or create a GitHub Issue in this repository.
31+
If you have questions, please file a [support ticket](https://support.sendgrid.com).

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ All updates to this library are documented in our [CHANGELOG](CHANGELOG.md).
2020
- [How to Contribute](#contribute)
2121
- [Thanks](#thanks)
2222
- [About](#about)
23+
- [Support](#support)
2324
- [License](#license)
2425

2526
<a name="installation"></a>
@@ -182,9 +183,10 @@ We were inspired by the work done on [birdy](https://github.com/inueni/birdy) an
182183

183184
php-http-client is maintained and funded by Twilio SendGrid, Inc. The names and logos for php-http-client are trademarks of Twilio SendGrid, Inc.
184185

185-
If you need help installing or using the library, please check the [Twilio SendGrid Support Help Center](https://support.sendgrid.com).
186+
<a name="support">
187+
# Support
186188

187-
If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!
189+
If you need help using SendGrid, please check the [Twilio SendGrid Support Help Center](https://support.sendgrid.com).
188190

189191
<a name="license"></a>
190192
# License

TROUBLESHOOTING.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
If you can't find a solution below, please open an [issue](https://github.com/sendgrid/php-http-client/issues).
2-
31
## Table of Contents
42

53
* [Viewing the Request Body](#request-body)

test/unit/FilesExistTest.php

-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ public function testFileArePresentInRepo()
1616
$this->assertFileExists("$rootDir/CODE_OF_CONDUCT.md");
1717
$this->assertFileExists("$rootDir/CONTRIBUTING.md");
1818
$this->assertFileExists("$rootDir/Dockerfile");
19-
$this->assertFileExists("$rootDir/ISSUE_TEMPLATE.md");
2019
$this->assertFileExists("$rootDir/LICENSE");
2120
$this->assertFileExists("$rootDir/PULL_REQUEST_TEMPLATE.md");
2221
$this->assertFileExists("$rootDir/README.md");

0 commit comments

Comments
 (0)