From 751e9d5060be561ba1dd528857db65caa5fb3bae Mon Sep 17 00:00:00 2001 From: Marius Poke Date: Fri, 12 Apr 2024 11:03:47 +0200 Subject: [PATCH] chore: use issue forms (#1783) * use issue forms * Update .github/ISSUE_TEMPLATE/02-feature-request.yml Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com> * Update .github/ISSUE_TEMPLATE/01-bug-report.yml Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com> * Update .github/ISSUE_TEMPLATE/03-docs-request.yml Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com> --------- Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/01-bug-report.yml | 52 ++++++++++++++ .github/ISSUE_TEMPLATE/02-feature-request.yml | 67 +++++++++++++++++++ .github/ISSUE_TEMPLATE/03-docs-request.yml | 18 +++++ .../{epic-template.md => 04-epic-template.md} | 2 +- ...issue-template.md => 05-issue-template.md} | 2 +- .github/ISSUE_TEMPLATE/bug-report.md | 34 ---------- .github/ISSUE_TEMPLATE/feature-request.md | 51 -------------- .../ISSUE_TEMPLATE/protocol-change-request.md | 39 ----------- 8 files changed, 139 insertions(+), 126 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/01-bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/02-feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/03-docs-request.yml rename .github/ISSUE_TEMPLATE/{epic-template.md => 04-epic-template.md} (89%) rename .github/ISSUE_TEMPLATE/{issue-template.md => 05-issue-template.md} (95%) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md delete mode 100644 .github/ISSUE_TEMPLATE/protocol-change-request.md diff --git a/.github/ISSUE_TEMPLATE/01-bug-report.yml b/.github/ISSUE_TEMPLATE/01-bug-report.yml new file mode 100644 index 0000000000..cb28218cad --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-bug-report.yml @@ -0,0 +1,52 @@ +name: 🐞 Bug report +description: Create a report to help us squash bugs! +title: "[Bug]: " +labels: ["type: bug", "status: waiting-triage"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + Before smashing the submit button please review the template. + + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search existing issues to avoid creating duplicates. + options: + - label: I have searched the existing issues + required: true + + - type: markdown + attributes: + value: | + IMPORTANT: Prior to opening a bug report, check if it affects one of the core modules + and if its eligible for a bug bounty on `SECURITY.md`. Bugs that are not submitted + through the appropriate channels won't receive any bounty. + + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + placeholder: Tell us what you see! + value: "A bug happened!" + validations: + required: true + + - type: input + attributes: + label: Interchain Security Version + description: If applicable, specify the version you're using + placeholder: v4.0.0, v4.1.0, main, etc. + validations: + required: true + + - type: textarea + id: reproduce + attributes: + label: How to reproduce? + description: If applicable could you describe how we could reproduce the bug + placeholder: Tell us how to reproduce the bug! + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/02-feature-request.yml b/.github/ISSUE_TEMPLATE/02-feature-request.yml new file mode 100644 index 0000000000..7cd5b0c6b7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-feature-request.yml @@ -0,0 +1,67 @@ +name: Feature Request +description: Create a proposal to request a feature +title: "[Feature]: " +labels: ["type: feature-request", "status: waiting-triage", "admin: epic"] +body: + - type: markdown + attributes: + value: | + ✰ Thanks for opening an issue! ✰ + + - type: textarea + id: summary + attributes: + label: Summary + description: | + What are the user needs? + How could this solution fix the user facing problem? + placeholder: Short, concise description of the proposed feature/changes to the repository + validations: + required: true + + - type: textarea + id: problem + attributes: + label: Problem Definition + description: | + If applicable please answer the below questions + Why do we need this feature? + What problems may be addressed by introducing this feature? + What benefits does ICS stand to gain by including this feature? + Are there any disadvantages of including this feature? + placeholder: Description of the issue being faced + validations: + required: false + + - type: textarea + id: proposal + attributes: + label: Proposed Feature + description: | + Description of the proposed features or changes to an existing feature to meet your needs + placeholder: Description of the proposed feature(s) + validations: + required: true + + - type: textarea + id: work + attributes: + label: Work Breakdown + description: | + Break the work into many tasks that will later be turned into issues that can be assigned to developers to work on. + This work may need to be broken up into phases of work in order to better organize when and how things get done. + placeholder: Description of the steps needed to deliver this feature + value: | + ```[tasklist] + #### Must have + - [ ] discuss proposal (if proposal rejected, close EPIC) + - [ ] create ADR (if ADR rejected, close EPIC) + - [ ] add sub-tasks needed to implement the proposed feature + ``` + + ```[tasklist] + #### Nice to have + - [ ] add sub-tasks that are nice to have for the proposed feature + ``` + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/03-docs-request.yml b/.github/ISSUE_TEMPLATE/03-docs-request.yml new file mode 100644 index 0000000000..e5b136a684 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-docs-request.yml @@ -0,0 +1,18 @@ +name: Documentation Request +description: Create an issue for missing or incorrect documentation +title: "[Documentation]: " +labels: ["type: docs-req", "status: waiting-triage"] +body: + - type: markdown + attributes: + value: | + ✰ Thanks for opening an issue! ✰ + Tell us what you would like to see get added to the documentation or if there is an error in the documentation? + + - type: textarea + id: what-happened + attributes: + label: Summary + placeholder: Description of what you would like to see + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/epic-template.md b/.github/ISSUE_TEMPLATE/04-epic-template.md similarity index 89% rename from .github/ISSUE_TEMPLATE/epic-template.md rename to .github/ISSUE_TEMPLATE/04-epic-template.md index 32a25e8458..9d68b4896a 100644 --- a/.github/ISSUE_TEMPLATE/epic-template.md +++ b/.github/ISSUE_TEMPLATE/04-epic-template.md @@ -1,7 +1,7 @@ --- name: EPIC Template about: Basic template for EPICs (used by the team) -labels: "admin: epic", "status: waiting-triage" +labels: 'admin: epic', 'status: waiting-triage' --- ## Problem diff --git a/.github/ISSUE_TEMPLATE/issue-template.md b/.github/ISSUE_TEMPLATE/05-issue-template.md similarity index 95% rename from .github/ISSUE_TEMPLATE/issue-template.md rename to .github/ISSUE_TEMPLATE/05-issue-template.md index cbfdaf8247..c4d53952cd 100644 --- a/.github/ISSUE_TEMPLATE/issue-template.md +++ b/.github/ISSUE_TEMPLATE/05-issue-template.md @@ -1,7 +1,7 @@ --- name: Issue Template about: Basic template for issues (used by the team) -labels: "status: waiting-triage" +labels: 'status: waiting-triage' --- - -## Summary of Bug - - - -## Version - - - -## Steps to Reproduce - - - -____ - -#### For Admin Use - -- [ ] Not duplicate issue -- [ ] Appropriate labels applied -- [ ] Appropriate contributors tagged -- [ ] Contributor assigned/self-assigned -- [ ] Is a spike necessary to map out how the issue should be approached? - diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index af7c52c285..0000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -name: Feature Request -about: Create a proposal to request a feature -labels: "type: feature-request", "admin: epic", "status: waiting-triage" ---- - - - -## Summary - - - -## Problem Definition - - - -## Proposal - - - -## Task list - -```[tasklist] -### Must have -- [ ] discuss proposal (if proposal rejected, close EPIC) -- [ ] create ADR (if ADR rejected, close EPIC) -- [ ] add sub-tasks needed to implement the proposed feature -``` - -```[tasklist] -### Nice to have -- [ ] add sub-tasks that are nice to have for the proposed feature -``` - -____ - -#### For Admin Use - -- [ ] Not duplicate issue -- [ ] Appropriate labels applied -- [ ] Appropriate contributors tagged -- [ ] Contributor assigned/self-assigned -- [ ] Is a spike necessary to map out how the issue should be approached? diff --git a/.github/ISSUE_TEMPLATE/protocol-change-request.md b/.github/ISSUE_TEMPLATE/protocol-change-request.md deleted file mode 100644 index be15342f29..0000000000 --- a/.github/ISSUE_TEMPLATE/protocol-change-request.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: Protocol change proposal -about: Create a proposal to request a change to the protocol -labels: "type: protocol-change", "status: waiting-triage" ---- - - - -## Protocol Change Proposal - -### Summary - - - -### Problem Definition - - - -### Proposal - - - -____ - -#### For Admin Use - -- [ ] Not duplicate issue -- [ ] Appropriate labels applied -- [ ] Appropriate contributors tagged -- [ ] Contributor assigned/self-assigned -- [ ] Is a spike necessary to map out how the issue should be approached? \ No newline at end of file