Skip to content

Commit

Permalink
chore: use issue forms (#1783)
Browse files Browse the repository at this point in the history
* use issue forms

* Update .github/ISSUE_TEMPLATE/02-feature-request.yml

Co-authored-by: Philip Offtermatt <[email protected]>

* Update .github/ISSUE_TEMPLATE/01-bug-report.yml

Co-authored-by: Philip Offtermatt <[email protected]>

* Update .github/ISSUE_TEMPLATE/03-docs-request.yml

Co-authored-by: Philip Offtermatt <[email protected]>

---------

Co-authored-by: Philip Offtermatt <[email protected]>
  • Loading branch information
mpoke and p-offtermatt committed Apr 12, 2024
1 parent a65bc96 commit 751e9d5
Show file tree
Hide file tree
Showing 8 changed files with 139 additions and 126 deletions.
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/01-bug-report.yml
Original file line number Diff line number Diff line change
@@ -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
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/02-feature-request.yml
Original file line number Diff line number Diff line change
@@ -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
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/03-docs-request.yml
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Issue Template
about: Basic template for issues (used by the team)
labels: "status: waiting-triage"
labels: 'status: waiting-triage'
---

<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
Expand Down
34 changes: 0 additions & 34 deletions .github/ISSUE_TEMPLATE/bug-report.md

This file was deleted.

51 changes: 0 additions & 51 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

39 changes: 0 additions & 39 deletions .github/ISSUE_TEMPLATE/protocol-change-request.md

This file was deleted.

0 comments on commit 751e9d5

Please sign in to comment.