Skip to content

Commit

Permalink
docs: Modify README.md in alignment with SendGrid Support (sendgrid#459)
Browse files Browse the repository at this point in the history
  • Loading branch information
garethpaul authored and qhenkart committed Mar 15, 2024
1 parent 28ae824 commit 04166ce
Show file tree
Hide file tree
Showing 6 changed files with 5 additions and 76 deletions.
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/config.yml

This file was deleted.

29 changes: 0 additions & 29 deletions CONTRIBUTING.md
Expand Up @@ -2,8 +2,6 @@ Hello! Thank you for choosing to help contribute to one of the Twilio SendGrid o

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.

- [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)
Expand All @@ -13,33 +11,6 @@ All third-party contributors acknowledge that any contributions they provide wil

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

<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** in order 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. 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.

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
30 changes: 0 additions & 30 deletions ISSUE_TEMPLATE.md

This file was deleted.

2 changes: 1 addition & 1 deletion PULL_REQUEST_TEMPLATE.md
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).
9 changes: 4 additions & 5 deletions README.md
Expand Up @@ -13,9 +13,7 @@ Version 3.X.X of this library provides full support for all Twilio SendGrid [Web

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-go/issues) and [pull requests](CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests.

Please browse the rest of this README for further detail.

We appreciate your continued support, thank you!
**If you need help using SendGrid, please check the [Twilio SendGrid Support Help Center](https://support.sendgrid.com).**

# Table of Contents

Expand Down Expand Up @@ -247,9 +245,10 @@ Please see our [troubleshooting guide](TROUBLESHOOTING.md) for common library is

sendgrid-go is maintained and funded by Twilio SendGrid, Inc. The names and logos for sendgrid-go 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"><a>
# 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).

# License
[The MIT License (MIT)](LICENSE)
1 change: 0 additions & 1 deletion sendgrid_test.go
Expand Up @@ -34,7 +34,6 @@ func TestRepoFiles(t *testing.T) {
"CHANGELOG.md",
"CODE_OF_CONDUCT.md",
"CONTRIBUTING.md",
"ISSUE_TEMPLATE.md",
"LICENSE",
"PULL_REQUEST_TEMPLATE.md",
"README.md",
Expand Down

0 comments on commit 04166ce

Please sign in to comment.