Skip to content

Commit 832502a

Browse files
authored
docs: Update to align with SendGrid Support (#144)
1 parent e98f15c commit 832502a

File tree

5 files changed

+5
-75
lines changed

5 files changed

+5
-75
lines changed

Diff for: .github/ISSUE_TEMPLATE/config.yml

-10
This file was deleted.

Diff for: 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 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

Diff for: ISSUE_TEMPLATE.md

-30
This file was deleted.

Diff for: README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ If you are looking for the SendGrid API client library, please see [this repo](h
1818
* [Usage](./USAGE.md)
1919
* [How to Contribute](#contribute)
2020
* [About](#about)
21+
* [Support](#support)
2122
* [License](#license)
2223

2324
<a name="announcements"></a>
@@ -129,7 +130,10 @@ Quick links:
129130

130131
java-http-client is maintained and funded by Twilio SendGrid, Inc. The names and logos for java-http-client are trademarks of Twilio SendGrid, Inc.
131132

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

134138
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!
135139

Diff for: src/test/java/com/sendgrid/TestRequiredFilesExist.java

-5
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,6 @@ public class TestRequiredFilesExist {
4545
assertTrue(new File("./CONTRIBUTING.md").exists());
4646
}
4747

48-
// ./ISSUE_TEMPLATE.md
49-
@Test public void checkIssuesTemplateExists() {
50-
assertTrue(new File("./ISSUE_TEMPLATE.md").exists());
51-
}
52-
5348
// ./LICENSE
5449
@Test public void checkLicenseExists() {
5550
assertTrue(new File("./LICENSE").exists());

0 commit comments

Comments
 (0)