From 849981d1ec4903f26106f2df38b75e37654076ca Mon Sep 17 00:00:00 2001 From: Corentin Thomasset Date: Thu, 30 Mar 2023 21:25:08 +0200 Subject: [PATCH] refactor(issue): better issue template --- .../{bug_report.md => bug-report.md} | 19 +++++++++--------- .github/ISSUE_TEMPLATE/feature_request.md | 20 ------------------- .github/ISSUE_TEMPLATE/new-tool-request.md | 19 ++++++++++++++++++ .github/ISSUE_TEMPLATE/other-request.md | 13 ++++++++++++ .github/ISSUE_TEMPLATE/tool-improvement.md | 13 ++++++++++++ 5 files changed, 55 insertions(+), 29 deletions(-) rename .github/ISSUE_TEMPLATE/{bug_report.md => bug-report.md} (67%) delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/new-tool-request.md create mode 100644 .github/ISSUE_TEMPLATE/other-request.md create mode 100644 .github/ISSUE_TEMPLATE/tool-improvement.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug-report.md similarity index 67% rename from .github/ISSUE_TEMPLATE/bug_report.md rename to .github/ISSUE_TEMPLATE/bug-report.md index 080ff121..c4bf532b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -1,17 +1,17 @@ --- name: Bug report -about: Create a report to help us improve -title: "[BUG] " +about: Create a report to help us improve our tools +title: '[BUG] ' labels: bug assignees: CorentinTh - --- -**Describe the bug** -A clear and concise description of what the bug is. +**Which tool is impacted?** +Example: the token generator **To Reproduce** Steps to reproduce the behavior: + 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' @@ -24,10 +24,11 @@ A clear and concise description of what you expected to happen. If applicable, add screenshots to help explain your problem. **Configuration (please complete the following information):** - - Device: [e.g. iPhone6, ] - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] + +- Device: [e.g. iPhone6, ] +- OS: [e.g. iOS] +- Browser [e.g. chrome, safari] +- Version [e.g. 22] **Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 764bc9e2..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "[FEAT]" -labels: enhancement -assignees: CorentinTh - ---- - -**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 [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/new-tool-request.md b/.github/ISSUE_TEMPLATE/new-tool-request.md new file mode 100644 index 00000000..58775d1a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-tool-request.md @@ -0,0 +1,19 @@ +--- +name: New tool request +about: Suggest a new tool idea +title: '[NEW TOOL]' +labels: new tool +assignees: CorentinTh +--- + +**Which tool is impacted?** +Example: the token generator + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Is their example of this tool in the wild?** +Provide link to already existing tool or npm packages if any exists + +**Additional context** +Add any other context about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/other-request.md b/.github/ISSUE_TEMPLATE/other-request.md new file mode 100644 index 00000000..b4901ed4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other-request.md @@ -0,0 +1,13 @@ +--- +name: Other request +about: Any request that does not concern a tool creation, a new feature request on a tool or a bug +title: '[OTHER] ' +labels: +assignees: CorentinTh +--- + +**Describe the solution you'd like** +A clear and concise description of what you want. + +**Additional context** +Add any other context about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/tool-improvement.md b/.github/ISSUE_TEMPLATE/tool-improvement.md new file mode 100644 index 00000000..8ff8bb6c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/tool-improvement.md @@ -0,0 +1,13 @@ +--- +name: Tool improvement +about: Improvement on an existing tool +title: '[TOOL IMPROVEMENT]' +labels: enhancement +assignees: CorentinTh +--- + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Additional context** +Add any other context about the feature request here.