From 8884ac01476a530a76eb1cc61a04fa23035ff131 Mon Sep 17 00:00:00 2001 From: "Gareth Paul Jones (GPJ)" Date: Wed, 4 May 2022 15:47:37 -0700 Subject: [PATCH] Modify README and other docs. --- .github/ISSUE_TEMPLATE/config.yml | 10 ---------- CONTRIBUTING.md | 25 ------------------------- ISSUE_TEMPLATE.md | 30 ------------------------------ README.md | 7 +++---- TROUBLESHOOTING.md | 4 +--- USE_CASES.md | 2 +- 6 files changed, 5 insertions(+), 73 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 b1e13329b..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-csharp+or+sendgrid+csharp - about: Ask questions on Stack Overflow - - name: Documentation - url: https://sendgrid.com/docs/for-developers/ - about: View Reference Documentation diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a88239f63..02387cab9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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) @@ -13,29 +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: - -## 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 - - -## 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). diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index be252f2af..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 -```csharp -# paste code here -``` - -### Exception/Log -``` -# paste exception/log here -``` - -### Technical details: -* sendgrid-csharp version: -* csharp version: - diff --git a/README.md b/README.md index 931504741..57f37719c 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,6 @@ Version 9.X.X+ of this library provides full support for all Twilio SendGrid [Web API v3](https://sendgrid.com/docs/API_Reference/api_v3.html) endpoints, including the new [v3 /mail/send](https://sendgrid.com/blog/introducing-v3mailsend-sendgrids-new-mail-endpoint). -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-csharp/issues) and [pull requests](CONTRIBUTING.md) or simply upvote or comment on existing issues or pull requests. - For updates to this library, see our [CHANGELOG](CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-csharp/releases). We appreciate your continued support, thank you! @@ -41,6 +39,7 @@ We appreciate your continued support, thank you! * [How to Contribute](#how-to-contribute) * [Troubleshooting](#troubleshooting) * [About](#about) +* [Support](#support) * [License](#license) # Installation @@ -267,9 +266,9 @@ Please see our [troubleshooting guide](TROUBLESHOOTING.md) for common library is sendgrid-csharp is maintained and funded by Twilio SendGrid, Inc. The names and logos for sendgrid-csharp 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 [The MIT License (MIT)](LICENSE) diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md index 69bdad992..d7cfe7d0b 100644 --- a/TROUBLESHOOTING.md +++ b/TROUBLESHOOTING.md @@ -2,8 +2,6 @@ If you have a non-library Twilio SendGrid issue, please contact our [support team](https://support.sendgrid.com). -If you can't find a solution below, please open an [issue](https://github.com/sendgrid/sendgrid-csharp/issues). - ## Table of Contents @@ -136,7 +134,7 @@ Please review [our guide](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/ v9 of this SDK is a complete rewrite that includes the removal of dynamic dependencies, a new Mail Helper and support for .NET Standard 1.3. -Please begin at the [README](https://github.com/sendgrid/sendgrid-csharp) and if you need further assistance, please [create an issue on GitHub](https://github.com/sendgrid/sendgrid-csharp/issues). +Please begin at the [README](https://github.com/sendgrid/sendgrid-csharp). ## Missing Classes diff --git a/USE_CASES.md b/USE_CASES.md index 0fd1cc1ed..63dd80c84 100644 --- a/USE_CASES.md +++ b/USE_CASES.md @@ -1,4 +1,4 @@ -This document provides examples for specific use cases. Please [open an issue](https://github.com/sendgrid/sendgrid-sharp/issues) or make a pull request for any use cases you would like us to document here. Thank you! +This document provides examples for specific use cases. # Table of Contents