Updated docs and issue templates

Author: alexeyzimarev

.github/ISSUE_TEMPLATE.md

@@ -2,37 +2,29 @@
 name: Bug report
 about: Create a report to help us improve
 title: ''
-labels: ''
+labels: 'bug'
 assignees: ''
 
 ---
 
+**DO NOT USE ISSUES FOR QUESTIONS**
+
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+Steps to reproduce the behavior, preferably using a code snippet. 
 
 **Expected behavior**
 A clear and concise description of what you expected to happen.
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+**Stack trace**
+Copy the full stack trace here if you get an exception.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+ - OS: [e.g. macOS]
+ - .NET version [e.g. .NET 5]
+ - Version [e.g. 107.0.4]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Get help
+    url: https://restsharp.dev/support/#get-help
+    about: Read about asking questions and reporting issues

.github/ISSUE_TEMPLATE/config.yml

@@ -2,11 +2,13 @@
 name: Feature request
 about: Suggest an idea for this project
 title: ''
-labels: ''
+labels: 'feature-request'
 assignees: ''
 
 ---
 
+**DO NOT USE ISSUES FOR QUESTIONS**
+
 **Is your feature request related to a problem? Please describe.**
 A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 

.github/ISSUE_TEMPLATE/feature_request.md

@@ -11,7 +11,7 @@ Got issues, questions, suggestions? Please read this page carefully to understan
 The most effective way to resolve questions about using RestSharp is StackOverflow.
 
 RestSharp has a large user base. Tens of thousands of projects and hundreds of thousands of developers
-use RestSharp on a daily basis. So, asking questions on StackOverflow with [restsharp](https://stackoverflow.com/questions/tagged/restsharp) tag
+use RestSharp on a daily basis. So, asking questions on **StackOverflow** with [restsharp](https://stackoverflow.com/questions/tagged/restsharp) tag
 would most definitely lead you to a solution.
 
 ::: warning
@@ -34,7 +34,7 @@ a crash or anything else that you consider a bug, is submitting an issue
 at our GitHub repository.
 
 ::: warning
-Please do not ignore our contribution guidelines, otherwise you risk your issue to be
+**Do not ignore our contribution guidelines**, otherwise you risk your issue to be
 closed without being considered. Respect the maintainers, be specific and provide
 as many details about the issue as you can.
 :::
@@ -55,45 +55,44 @@ Here are contribution guidelines:
 
  - Make each pull request atomic and exclusive; don't send pull requests for a laundry list of changes.
  - Even better, commit in small manageable chunks.
- - Use the supplied `.DotSettings` file to format the code.
+ - Use the supplied `.editorconfig` file to format the code.
  - Any change must be accompanied by a unit test covering the change.
- - New tests are preferred to use Shoudly.
- - No regions except for license header
- - Code must build for .NET Standard 2.0 and .NET Framework 4.5.2.
- - Test must run on .NET Core 3.1 and .NET Framework 4.5.2
+ - New tests are preferred to use FluentAssertions.
+ - No regions.
+ - No licence header for tested.
+ - Code must build for .NET Standard 2.0, .NET 5, and .NET 6.
+ - Test must run on .NET 6.
  - Use `autocrlf=true` (`git config --global core.autocrlf true` [http://help.github.com/dealing-with-lineendings/])
 
 ### Sponsor
 
 You can also support maintainers and motivate them by contributing
 financially at [Open Collective](https://opencollective.com/restsharp).
 
-## Common Issues
+## Common issues
 
 Before opening an issue on GitHub, please check the list of known issues below.
 
-### Connection closed with SSL
+### Content type
 
-When connecting via HTTPS, you get an exception:
+One of the mistakes developers make when using RestSharp is setting the `Content-Type` header manually.
+Remember that in most of the usual scenarios setting the content type header manually is not required, and it might be harmful.
 
-> The underlying connection was closed: An unexpected error occurred on a send
-
-The exception is thrown by `WebRequest` so you need to tell the .NET Framework to
-accept more certificate types than it does by default.
-
-Adding this line somewhere in your application, where it gets called once, should solve the issue:
+RestSharp sets the content type header automatically based on the request type. 
+You might want to override the request body content type, but the best way to do it is to supply the content type to the body parameter itself.
+Functions for adding the request body to the request have overloads, which accept content type. For example
 
 ```csharp
-ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12 | SecurityProtocolType.Tls11 | SecurityProtocolType.Tls;
+request.AddStringBody(jsonString, ContentType.Json);
 ```
 
 ### Setting the User Agent
 
 Setting the user agent on the request won't work when you use `AddHeader`.
 
-Instead, please use the `RestClient.UserAgent` property.
+Instead, please use the `RestClientOptions.UserAgent` property.
 
-### Empty Response
+### Empty response
 
 We regularly get issues where developers complain that their requests get executed
 and they get a proper raw response, but the `RestResponse<T>` instance doesn't
@@ -105,7 +104,7 @@ All those issues are caused by the design choice to swallow exceptions
 that occur when RestSharp makes the request and processes the response. Instead,
 RestSharp produces so-called _error response_.
 
-You can check the response status to find out if there're any errors.
+You can check the response status to find out if there are any errors.
 The following properties can tell you about those errors:
 
 - `IsSuccessful`

docs/support/README.md

@@ -84,16 +84,12 @@ You can also make POST (and PUT/DELETE/HEAD/OPTIONS) requests:
 ```csharp
 // TwilioApi.cs, method of TwilioApi class
 public Task<Call> InitiateOutboundCall(CallOptions options) {
-    Require.Argument("Caller", options.Caller);
-    Require.Argument("Called", options.Called);
-    Require.Argument("Url", options.Url);
-
-    var request = new RestRequest("Accounts/{AccountSid}/Calls");
-    request.RootElement = "Calls";
-
-    request.AddParameter("Caller", options.Caller);
-    request.AddParameter("Called", options.Called);
-    request.AddParameter("Url", options.Url);
+    var request = new RestRequest("Accounts/{AccountSid}/Calls") {
+        RootElement = "Calls"
+    }
+        .AddParameter("Caller", options.Caller)
+        .AddParameter("Called", options.Called)
+        .AddParameter("Url", options.Url);
 
     if (options.Method.HasValue) request.AddParameter("Method", options.Method);
     if (options.SendDigits.HasValue()) request.AddParameter("SendDigits", options.SendDigits);
@@ -251,8 +247,7 @@ client.UseNewtonsoftJson();
 The serializer configures some options by default:
 
 ```csharp
-JsonSerializerSettings DefaultSettings = new JsonSerializerSettings
-{
+JsonSerializerSettings DefaultSettings = new JsonSerializerSettings {
     ContractResolver     = new CamelCasePropertyNamesContractResolver(),
     DefaultValueHandling = DefaultValueHandling.Include,
     TypeNameHandling     = TypeNameHandling.None,
@@ -273,16 +268,14 @@ deserialization, you must implement the `IRestSerializer` interface.
 Here is an example of a custom serializer that uses `System.Text.Json`:
 
 ```csharp
-public class SimpleJsonSerializer : IRestSerializer
-{
+public class SimpleJsonSerializer : IRestSerializer {
     public string Serialize(object obj) => JsonSerializer.Serialize(obj);
 
     public string Serialize(Parameter bodyParameter) => Serialize(bodyParameter.Value);
 
     public T Deserialize<T>(IRestResponse response) => JsonSerializer.Deserialize<T>(response.Content);
 
-    public string[] SupportedContentTypes { get; } =
-    {
+    public string[] SupportedContentTypes { get; } = {
         "application/json", "text/json", "text/x-json", "text/javascript", "*+json"
     };
 
@@ -318,6 +311,39 @@ in favour of giving you the error as a property.
 
 Those properties are available for the `RestClient` instance and will be used for all request made with that instance.
 
+::: warning
+Please be aware that deserialization failures will only work if the serializer throws an exception when deserializing the response.
+Many serializers don't throw by default, and just return a `null` result. RestSharp is unable to figure out why `null` is returned, so it won't fail in this case.
+Check the serializer documentation to find out if it can be configured to throw on deserialization error.
+:::
+
 There are also slight differences on how different overloads handle exceptions.
 
 Asynchronous generic methods `GetAsync<T>`, `PostAsync<T>` and so on, which aren't a part of `RestClient` interface (those methods are extension methods) return `Task<T>`. It means that there's no `RestResponse` to set the response status to error. We decided to throw an exception when such a request fails. It is a trade-off between the API consistency and usability of the library. Usually, you only need the content of `RestResponse` instance to diagnose issues and most of the time the exception would tell you what's wrong. 
+
+Below you can find how different extensions deal with errors. Note that functions, which don't throw by default, will throw exceptions when `ThrowOnAnyError` is set to `true`.
+
+| Function              | Throws on errors |
+|:----------------------|:-----------------|
+| `ExecuteAsync`        | No |
+| `ExecuteGetAsync`     | No |
+| `ExecuteGetAsync<T>`  | No |
+| `ExecutePostAsync`    | No |
+| `ExecutePutAsync`     | No |
+| `ExecuteGetAsync<T>`  | No |
+| `ExecutePostAsync<T>` | No |
+| `ExecutePutAsync<T>`  | No |
+| `GetAsync`            | Yes |
+| `GetAsync<T>`         | Yes |
+| `PostAsync`           | Yes |
+| `PostAsync<T>`        | Yes |
+| `PatchAsync`          | Yes |
+| `PatchAsync<T>`       | Yes |
+| `DeleteAsync`         | Yes |
+| `DeleteAsync<T>`      | Yes |
+| `OptionsAsync`        | Yes |
+| `OptionsAsync<T>`     | Yes |
+| `HeadAsync`           | Yes |
+| `HeadAsync<T>`        | Yes |
+
+In addition, all the functions for JSON requests, like `GetJsonAsync` and `PostJsonAsyn` throw an exception if the HTTP call fails.