Skip to content

Commit 80ad8a4

Browse files
authored
docs: Modify Docs to align with SendGrid Support (#118)
1 parent fffe5a7 commit 80ad8a4

7 files changed

Lines changed: 6 additions & 80 deletions

File tree

.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 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 & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ All updates to this module are documented in our [CHANGELOG](CHANGELOG.md).
1616
- [Usage](#usage)
1717
- [How to Contribute](#contribute)
1818
- [About](#about)
19+
- [Support](#support)
1920
- [License](#license)
2021

2122
<a name="installation"></a>
@@ -111,9 +112,10 @@ Quick links:
111112

112113
smtpapi-java is maintained and funded by Twilio SendGrid, Inc. The names and logos for smtpapi-java are trademarks of Twilio SendGrid, Inc.
113114

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

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

118120
<a name="license"></a>
119121
# License

TROUBLESHOOTING.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
If you have a non-library SendGrid issue, please contact our [support team](https://support.sendgrid.com).
2-
3-
If you can't find a solution below, please open an [issue](https://github.com/sendgrid/smtpapi-java/issues).
1+
If you have a SendGrid issue, please contact our [support team](https://support.sendgrid.com).
42

53
## Table of Contents
64

src/test/java/com/sendgrid/smtpapi/ProjectTest.java

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,6 @@ public class ProjectTest {
3333
assertEquals(true, new File("./CONTRIBUTING.md").exists());
3434
}
3535

36-
// ./ISSUE_TEMPLATE.md
37-
@Test public void checkIssuesTemplateExists() {
38-
assertEquals(true, new File("./ISSUE_TEMPLATE.md").exists());
39-
}
40-
4136
// ./LICENSE
4237
@Test public void checkLicenseExists() {
4338
assertEquals(true, new File("./LICENSE").exists());

0 commit comments

Comments
 (0)