Skip to content

Commit 250a3a4

Browse files
authored
docs: Update docs in alignment with SendGrid Support (#131)
1 parent 5bf883f commit 250a3a4

File tree

7 files changed

+6
-80
lines changed

7 files changed

+6
-80
lines changed

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 0 additions & 10 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 0 additions & 29 deletions
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 libraries. There are many ways you can contribute and help is always welcome. We simply 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** in order 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. In order 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

ISSUE_TEMPLATE.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ All updates to this library are documented in our [CHANGELOG](CHANGELOG.md).
1919
- [Usage](#usage)
2020
- [How to Contribute](#contribute)
2121
- [About](#about)
22+
- [Support](#support)
2223
- [License](#license)
2324

2425
<a name="installation"></a>
@@ -90,8 +91,6 @@ We encourage contribution to our libraries, please see our [CONTRIBUTING](CONTRI
9091

9192
Quick links:
9293

93-
- [Feature Request](CONTRIBUTING.md#feature-request)
94-
- [Bug Reports](CONTRIBUTING.md#submit-a-bug-report)
9594
- [Improvements to the Codebase](CONTRIBUTING.md#improvements-to-the-codebase)
9695
- [Review Pull Requests](CONTRIBUTING.md#code-reviews)
9796

@@ -100,9 +99,10 @@ Quick links:
10099

101100
ruby-http-client is maintained and funded by Twilio SendGrid, Inc. The names and logos for ruby-http-client are trademarks of Twilio SendGrid, Inc.
102101

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

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

107107
# License
108108
[The MIT License (MIT)](LICENSE)

TROUBLESHOOTING.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
If you have a non-library SendGrid issue, please contact our [support team](https://support.sendgrid.com).
1+
If you have a SendGrid issue, please contact our [support team](https://support.sendgrid.com).
22

3-
If you can't find a solution below, please open an [issue](https://github.com/sendgrid/ruby-http-client/issues).
43

54
## Table of Contents
65
* [Viewing the Request Body](#request-body)

test/test_ruby_http_client.rb

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -372,10 +372,6 @@ def test_contributing_exists
372372
assert(File.file?('./CONTRIBUTING.md'))
373373
end
374374

375-
def test_issue_template_exists
376-
assert(File.file?('./ISSUE_TEMPLATE.md'))
377-
end
378-
379375
def test_license_exists
380376
assert(File.file?('./LICENSE'))
381377
end

0 commit comments

Comments
 (0)