From b9ae60e715c3858ac4cd0abe4f5f1101780d817c Mon Sep 17 00:00:00 2001 From: "Gareth Paul Jones (GPJ)" Date: Mon, 9 May 2022 10:03:37 -0700 Subject: [PATCH] docs: Modify README.md in alignment with SendGrid Support (#1360) --- .github/ISSUE_TEMPLATE/config.yml | 10 ---------- ISSUE_TEMPLATE.md | 30 ------------------------------ PULL_REQUEST_TEMPLATE.md | 2 +- README.md | 7 ++++--- test/files.spec.js | 4 ---- 5 files changed, 5 insertions(+), 48 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml deleted file mode 100644 index 155e8e222..000000000 --- a/.github/ISSUE_TEMPLATE/config.yml +++ /dev/null @@ -1,10 +0,0 @@ -contact_links: - - name: Twilio SendGrid Support - url: https://support.sendgrid.com - about: Get Support - - name: Stack Overflow - url: https://stackoverflow.com/questions/tagged/sendgrid-nodejs+or+sendgrid+node - about: Ask questions on Stack Overflow - - name: Documentation - url: https://sendgrid.com/docs/for-developers/ - about: View Reference Documentation diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index bfd860789..000000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,30 +0,0 @@ - - -### Issue Summary -A summary of the issue and the environment in which it occurs. If suitable, include the steps required to reproduce the bug. Please feel free to include screenshots, screencasts, or code examples. - -### Steps to Reproduce -1. This is the first step -2. This is the second step -3. Further steps, etc. - -### Code Snippet -```node -# paste code here -``` - -### Exception/Log -``` -# paste exception/log here -``` - -### Technical details: -* sendgrid-nodejs version: -* node version: - diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index bb0607651..7acf1eac0 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -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). \ No newline at end of file diff --git a/README.md b/README.md index 6f27b28bb..547a66f3c 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ We want this library to be community-driven, and Twilio SendGrid led. We need yo For updates to this library, see our [CHANGELOG](CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-nodejs/releases). -We appreciate your continued support, thank you! +**If you need support using Sendgrid, please check the [Twilio SendGrid Support Help Center](https://support.sendgrid.com).** # Table of Contents @@ -68,9 +68,10 @@ Please see our [troubleshooting guide](TROUBLESHOOTING.md) for common library is sendgrid-nodejs is maintained and funded by Twilio SendGrid, Inc. The names and logos for sendgrid-nodejs 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). + +# 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 diff --git a/test/files.spec.js b/test/files.spec.js index f26ae68db..207caba84 100644 --- a/test/files.spec.js +++ b/test/files.spec.js @@ -36,10 +36,6 @@ describe('sendgrid-nodejs repo', function() { assert(fileExists('CONTRIBUTING.md')); }); - it('should have ./ISSUE_TEMPLATE.md file', function() { - assert(fileExists('ISSUE_TEMPLATE.md')); - }); - it('should have ./LICENSE file', function() { assert(fileExists('LICENSE')); });