Skip to content

docs: Update docs to align with SendGrid Support #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 12, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/config.yml

This file was deleted.

29 changes: 0 additions & 29 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,12 @@
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.

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

<a name="feature-request"></a>
## Feature Request

If you'd like to make a feature request, please read this section.

The GitHub issue tracker is the preferred channel for library feature requests, but please respect the following restrictions:

- Please **search for existing issues** to ensure we don't have duplicate bugs/feature requests.
- Please be respectful and considerate of others when commenting on issues

<a name="submit-a-bug-report"></a>
## Submit a Bug Report

Note: DO NOT include your credentials in ANY code examples, descriptions, or media you make public.

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.

Before you decide to create a new issue, please try the following:

1. Check the Github issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
2. Update to the latest version of this code and check if the issue has already been fixed
3. Copy and fill in the Bug Report Template we have provided below

### Please use our Bug Report Template

In order to make the process easier, we've included a [sample bug report template](ISSUE_TEMPLATE.md).

<a name="improvements-to-the-codebase"></a>
## Improvements to the Codebase

Expand Down
2 changes: 1 addition & 1 deletion FIRST_TIMERS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# How To Contribute to Twilio SendGrid Repositories via GitHub
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.
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.

To make a pull request, follow these steps:

Expand Down
30 changes: 0 additions & 30 deletions ISSUE_TEMPLATE.md

This file was deleted.

2 changes: 1 addition & 1 deletion PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ A short description of what this PR does.
- [ ] I have added the necessary documentation about the functionality in the appropriate .md file
- [ ] I have added inline documentation to the code I modified

If you have questions, please file a [support ticket](https://support.sendgrid.com), or create a GitHub Issue in this repository.
If you have questions, please file a [support ticket](https://support.sendgrid.com).
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ All updates to this library are documented in our [CHANGELOG](CHANGELOG.md).
- [How to Contribute](#contribute)
- [Thanks](#thanks)
- [About](#about)
- [Support](#support)
- [License](#license)

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

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.

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

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!
If you need help using SendGrid, please check the [Twilio SendGrid Support Help Center](https://support.sendgrid.com).

<a name="license"></a>
# License
Expand Down
2 changes: 0 additions & 2 deletions TROUBLESHOOTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
If you can't find a solution below, please open an [issue](https://github.com/sendgrid/php-http-client/issues).

## Table of Contents

* [Viewing the Request Body](#request-body)
Expand Down
1 change: 0 additions & 1 deletion test/unit/FilesExistTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ public function testFileArePresentInRepo()
$this->assertFileExists("$rootDir/CODE_OF_CONDUCT.md");
$this->assertFileExists("$rootDir/CONTRIBUTING.md");
$this->assertFileExists("$rootDir/Dockerfile");
$this->assertFileExists("$rootDir/ISSUE_TEMPLATE.md");
$this->assertFileExists("$rootDir/LICENSE");
$this->assertFileExists("$rootDir/PULL_REQUEST_TEMPLATE.md");
$this->assertFileExists("$rootDir/README.md");
Expand Down