Skip to content

Commit

Permalink
chore: add generic github issue templates to backstage-plugins (#724)
Browse files Browse the repository at this point in the history
* chore: add generic github issue templates to backstage-plugins

* chore: update .github/ISSUE_TEMPLATE/documentation.md

Co-authored-by: Jaivardhan Kumar <[email protected]>

* chore: update .github/ISSUE_TEMPLATE/documentation.md

Co-authored-by: Jaivardhan Kumar <[email protected]>

* chore: update enhancement and epic issue templates

---------

Co-authored-by: Jaivardhan Kumar <[email protected]>
  • Loading branch information
Zaperex and invincibleJai authored Sep 15, 2023
1 parent 225c4e2 commit cb2e4e9
Show file tree
Hide file tree
Showing 6 changed files with 86 additions and 45 deletions.
28 changes: 11 additions & 17 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,19 @@
---
name: Bug report
about: Create a bug report to help us improve
labels: [kind/bug, status/triage]
name: Bug Report
about: If something isn't working
labels: ['kind/bug', 'status/triage']
---

**Describe the bug**
A clear and concise description of what the bug is.
### Describe the bug

**To Reproduce**
Steps to reproduce the behavior:
A clear and concise description of what the bug is. (provide screenshots if applicable)

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
### Expected Behavior

**Expected behavior**
A clear and concise description of what you expected to happen.
### What are the steps to reproduce this bug?

**Screenshots**
If applicable, add screenshots to help explain your problem.
1.
2.
3.

**Additional context**
Add any other context about the problem here.
### Versions of software used and environment
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Documentation
about: Improve an existing feature or workflow
labels: ['kind/documentation', 'status/triage']
---

### What do you want to improve?

### What does the current documentation state?

### What would you like to be added/updated in the documentation?
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Enhancement
about: Improve an existing feature or workflow
labels: ['kind/enhancement', 'status/triage']
---

### What do you want to improve?

### What is the current behavior?

### What will the new behavior be?
27 changes: 16 additions & 11 deletions .github/ISSUE_TEMPLATE/epic.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,25 @@
---
name: Epic
about: Create an epic
labels: [kind/epic, status/triage]
about: A long-lived feature request consisting of a collection is related issues. Must include a checklist of items that must be completed. If you are not sure if this is an epic, open an enhancement request.
labels: ['kind/epic', 'status/triage']
---

**Goal**
A clear and concise description of the goal of this epic.
## Goal

**What problem does this solve? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
## Acceptance criteria

**Use cases**
A clear and concise description of persona and associated use cases that need to be supported.
- [ ] tdb

**Acceptance criteria**
A clear and concise list of acceptance criteria, noting what will be delivered as part of this epic. This will help identify associated testing, documentation and support needs.
## Requirements

- [ ] Test plan
- [ ] Documentation

## Issues in Epic

- [ ] tbd

## Notes

**Additional context**
Add any other context or screenshots about the feature request here.
Add any other context or screenshots about the epic here.
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/quality.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Quality Assurance
about: Tests for code changes
labels: ['kind/quality', 'status/triage']
---

### What needs to be tested

### Describe how to verify the feature and functionality

### Prerequisites and test environment

-
-
-

### Describe configuration requirements

-
-
-

### Test Suites

Outline the test suites and testing steps required:

**Test case 1:**

- Step 1-1
- Step 1-2
- Step 1-3

**Test case 2:**

- Step 2-1
- Step 2-2
- Step 2-3

0 comments on commit cb2e4e9

Please sign in to comment.