From 3a615124ce186629287b5238f28dba0ffd313d7f Mon Sep 17 00:00:00 2001 From: Oliver Booth <1129769+oliverbooth@users.noreply.github.com> Date: Sun, 19 Apr 2020 14:58:25 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=90=9E=20Add=20issue=20templates?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/ISSUE_TEMPLATE/bug_report.md | 24 ++++++++++ .../extension-method-request.md | 45 +++++++++++++++++++ 2 files changed, 69 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/extension-method-request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..e2dcd19 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,24 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: oliverbooth + +--- + +**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 + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/extension-method-request.md b/.github/ISSUE_TEMPLATE/extension-method-request.md new file mode 100644 index 0000000..0020135 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/extension-method-request.md @@ -0,0 +1,45 @@ +--- +name: Extension method request +about: Make a request for an extension method you believe should be implemented +title: '' +labels: '' +assignees: '' + +--- + +**Type** +Provide the fully-qualified type name of the extension method you wish to have here. Example: +```cs +System.String +``` + +**Extension method signature** +Provide the full method signature here, without parameter names, but do not include the leading `this T x` parameter. Example: +```cs +string Random(int, System.Random) +``` + +**Parameters** +Document each of the parameters here, with their name and description - i.e. this would be equivalent to the entry in the XMLDoc. Use a table layout like in the following example: +| Parameter | Type | Description | +|- |- |- | +|length|`int`|The length of the string to generate.| +|random|`System.Random`|The instance of `System.Random` to use for the operation| + +**Description** +Briefly but concisely document the method's purpose here. i.e. This would be the `` entry in the XMLDoc. + +**Benefits** +Give a reason as to why this method should be added. Does it add a need not satisified by any other X10D method? Does .NET not offer similar operations? Why should this method exist? + +**Drawbacks** +Give a reason as to why this method should *not* be added. Is it an expensive operation? Does it defy .NET guidelines? If you cannot think of any, leave this blank. + +**(Optional) Implementation example** +If you prefer, you can give an example of how this method might be implemented using a C# codeblock. +Do not include the method signature here - just the body. +```cs +{ + // code +} +```