Skip to content

Commit 4c33cea

Browse files
authored
docs: Modify README.md in alignment with SendGrid Support (#732)
1 parent 87d006f commit 4c33cea

File tree

6 files changed

+6
-81
lines changed

6 files changed

+6
-81
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
@@ -3,8 +3,6 @@ Hello! Thank you for choosing to help contribute to one of the Twilio SendGrid o
33
**All third party contributors acknowledge that any contributions they provide will be made under the same open source license that the open source project is provided under.**
44

55
- [Feature Request](#feature-request)
6-
- [Submit a Bug Report](#submit-a-bug-report)
7-
- [Please use our Bug Report Template](#please-use-our-bug-report-template)
86
- [Improvements to the Codebase](#improvements-to-the-codebase)
97
- [Development Environment](#development-environment)
108
- [Install and Run Locally](#install-and-run-locally)
@@ -20,33 +18,6 @@ Hello! Thank you for choosing to help contribute to one of the Twilio SendGrid o
2018

2119
There are a few ways to contribute, which we'll enumerate below:
2220

23-
<a name="feature-request"></a>
24-
## Feature Request
25-
26-
If you'd like to make a feature request, please read this section.
27-
28-
The GitHub issue tracker is the preferred channel for library feature requests, but please respect the following restrictions:
29-
30-
- Please **search for existing issues** in order to ensure we don't have duplicate bugs/feature requests.
31-
- Please be respectful and considerate of others when commenting on issues
32-
33-
<a name="submit-a-bug-report"></a>
34-
## Submit a Bug Report
35-
36-
Note: DO NOT include your credentials in ANY code examples, descriptions, or media you make public.
37-
38-
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.
39-
40-
Before you decide to create a new issue, please try the following:
41-
42-
1. Check the GitHub issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
43-
2. Update to the latest version of this code and check if the issue has already been fixed
44-
3. Copy and fill in the Bug Report Template we have provided below
45-
46-
### Please use our Bug Report Template
47-
48-
In order to make the process easier, we've included a [sample bug report template](ISSUE_TEMPLATE.md).
49-
5021
<a name="improvements-to-the-codebase"></a>
5122
## Improvements to the Codebase
5223

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: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@ Version 3.X.X of this library provides full support for all Twilio SendGrid [Web
1313

1414
This library represents the beginning of a new path for Twilio SendGrid. We want this library to be community driven and Twilio SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/sendgrid/sendgrid-java/issues) and [pull requests](CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests.
1515

16-
Please browse the rest of this README for further details.
17-
18-
We appreciate your continued support, thank you!
16+
**If you need help using SendGrid, please check the [Twilio SendGrid Support Help Center](https://support.sendgrid.com).**
1917

2018
# Table of Contents
2119

@@ -27,6 +25,7 @@ We appreciate your continued support, thank you!
2725
* [How to Contribute](#contribute)
2826
* [Troubleshooting](#troubleshooting)
2927
* [About](#about)
28+
* [Support](#support)
3029
* [License](#license)
3130

3231
<a name="installation"></a>
@@ -220,9 +219,10 @@ Please see our [troubleshooting guide](TROUBLESHOOTING.md) for common library is
220219

221220
sendgrid-java is maintained and funded by Twilio SendGrid, Inc. The names and logos for sendgrid-java are trademarks of Twilio SendGrid, Inc.
222221

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

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

227227
# License
228228

src/test/java/com/sendgrid/TestRequiredFilesExist.java

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,6 @@ public void checkContributingGuideExists() {
4343
assertTrue(new File("./CONTRIBUTING.md").exists());
4444
}
4545

46-
// ./ISSUE_TEMPLATE.md
47-
@Test
48-
public void checkIssuesTemplateExists() {
49-
assertTrue(new File("./ISSUE_TEMPLATE.md").exists());
50-
}
51-
5246
// ./LICENSE
5347
@Test
5448
public void checkLicenseExists() {

0 commit comments

Comments
 (0)