From 99bb7cb0f6e5294c193c64ea6339f8cae2a49657 Mon Sep 17 00:00:00 2001 From: Harry Solovay Date: Mon, 3 Oct 2022 01:42:59 +0700 Subject: [PATCH] chore: template cleanup (#255) Co-authored-by: T6 Co-authored-by: T6 --- .github/ISSUE_TEMPLATE/BUG_REPORT.md | 39 +++++++++++------------ .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md | 27 +++++++--------- .github/PULL_REQUEST_TEMPLATE.md | 22 +++++-------- 3 files changed, 39 insertions(+), 49 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md index 44fa66352..ffb5ac6b9 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.md +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -1,36 +1,37 @@ --- - -name: Bug Report -about: Create a report to help us improve -title: +name: Bug +about: Identify faulty behavior +title: "" labels: bug - --- -<!-- Please search to see if an issue already exists for the bug you encountered. --> +## Bug Report -**Current Behavior** +<!-- Please search Capi's issues in case one already exists for this bug. --> -<!-- A concise description of what you're experiencing. --> +### Current Behavior -**Expected Behavior** +<!-- TODO --> -<!-- A concise description of what you expected to happen. --> +### Expected Behavior** -**Steps To Reproduce** +<!-- TODO --> + +### Steps To Reproduce** <!-- -Example: steps to reproduce the behavior: +Example: + 1. In this environment... -2. With this config... -3. Run '...' -4. See error... +2. ... with this code... +3. ... run this command. --> -**Environment** +### Environment <!-- Example: + - Deno: ... (deno --version) - Node: ... (node -v) - Browser: ... @@ -38,8 +39,6 @@ Example: - Language: TypeScript vX.Y.Z (tsc --version) / JavaScript / ... --> -**Anything else** +### Additional Information -<!-- -Links? References? Github repository? Anything that will give us more context about the issue that you are encountering! ---> +<!-- Is there anything else that might help us tackle this bug (a public GitHub repo perhaps)? --> diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md index 9a41e0f8e..2b8616e42 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md @@ -1,25 +1,22 @@ --- - name: Feature Request -about: Suggest an idea for this project -title: <title> +about: Suggest an idea +title: "" labels: feature - --- -<!-- -Thank you for suggesting an idea to make the project better. +## Feature Request + +<!-- Please search Capi's issues incase one already exists for this idea. --> + +### Suggestion -Please fill in as much of the template below as you're able. +<!-- TODO --> -Note: Please search to see if the feature request already exists or has been discussed. ---> +### Motivation -**Is your feature request related to a problem? Please describe.** -Please describe the problem you are trying to solve. +<!-- TODO --> -**Describe the solution you'd like** -Please describe the desired behavior. +### Use Cases -**Describe alternatives you've considered** -Please describe alternative solutions or features you have considered. +<!-- TODO --> diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index eca8069b1..3682000bf 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,16 +1,10 @@ -<!--- Provide a general summary of your changes in the title above, following conventional commit --> +Resolves # -**Description** +- [ ] There is an associated issue (**required**) +- [ ] The change is described in detail +- [ ] There are no merge conflicts +- [ ] All CI checks pass +- [ ] There are new or updated tests validating the change +- [ ] The title conforms to [the conventional commit standard](https://www.conventionalcommits.org/en/v1.0.0/) -<!--- Link to the open issue this addresses --> - -Fixes # - -<!--- Describe your changes in detail --> - -**How Has This Been Tested?** - -<!--- Please describe in detail how you tested your changes. --> -<!--- Include details of your testing environment, and the tests you ran to --> -<!--- see how your change affects other areas of the code, etc. --> -<!--- validate CI checks passed --> +## Description