Skip to content

Commit 2c5882b

Browse files
Merge #4555
4555: Update the issue templates r=Jimbo4350 a=dorin100 - I removed the duplicated user-facing template - I updated the default labels for the issue templates Co-authored-by: dorin100 <Bica123!>
2 parents 51befb0 + 68c8a9d commit 2c5882b

File tree

4 files changed

+40
-52
lines changed

4 files changed

+40
-52
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: Bug report
33
about: Report a bug to help us improve
44
title: "[BUG] - "
5-
labels: bug
5+
labels: "type: bug"
66
assignees: ''
77

88
---

.github/ISSUE_TEMPLATE/feature_request.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: Feature request
33
about: Submit a feature request
44
title: "[FR] - "
5-
labels: enhancement
5+
labels: "type: enhancement"
66
assignees: ''
77

88
---
+38-19
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,59 @@
11
---
22
name: User facing feature
3-
about: For internal use
4-
title: ''
5-
labels: ''
3+
about: For internal use only; Open a user-facing feature tracking file
4+
title: "[FEATURE] - "
5+
labels: ["type: internal-feature", "user type: internal"]
66
assignees: ''
77

88
---
99

10-
## What - The user facing feature being implemented
10+
## What
11+
<!-- What the end user will see -->
1112

1213
## Why
14+
<!-- The reason why this user-facing feature is being implemented -->
1315

14-
## Personas - Who will this affect?
16+
## Personas
17+
<!-- Who will this affect? -->
1518

16-
- [ ] SPO
17-
- [ ] Dapp Devs
19+
- [ ] SPOs
20+
- [ ] dApp Devs
1821
- [ ] Exchanges
22+
- [ ] Wallets
23+
- [ ] 3rd party tools
24+
- [ ] ADA holders
1925

20-
## Acceptance Criteria
21-
22-
## Definition of done
26+
## Definition of Done (DoD)
2327

24-
- [ ] Code review
28+
- [ ] [Acceptance Criteria + User Stories & DoD](https://input-output.atlassian.net/wiki/spaces/QA/pages/3584229468/Acceptance+Criteria+DoD) created and singed-off (by PO, dev & test owners)
2529
- [ ] Builds successfully on CI
26-
- [ ] Includes documentation and/or examples for the functionality
30+
- [ ] Code & Test review (as per Acceptance Criteria)
31+
- [ ] There is documentation and/or examples for the new functionality (usage/response)
2732
- [ ] Log/record changes on **Vnext** (or similar depending on what we adopt)
28-
- [ ] Ticket number included in PR description
29-
- [ ] The new functionality is covered by dev/unit/property tests
30-
- [ ] Acceptance Criteria met
31-
- [ ] Test Engineering Sign-off + E2E automated tests
33+
- [ ] Ticket number(s) included in PR description
34+
- [ ] All Acceptance Criteria met and covered by dev/unit/property/integration tests
35+
- [ ] System/E2E automated tests + System Test Engineer Owner Sign-off
36+
37+
> **_NOTE:_** Ideally, we should merge only fully implemented and tested features into the master branch.
38+
> So all the above steps are required for the PR to be merged.
39+
> In order to avoid the PRs becoming stale and requiring to be rebased on master, these can be merged
40+
> after a reasonable time (current agreement is 3 days) if the System Test Engineer Owner's sign-off
41+
> was not provided (last step in the DoD).
42+
43+
> **_IMPORTANT:_** Any deviation from the plan should be discussed and agreed as a comment in the Feature file.
3244
3345
## Sign-off
3446

35-
- [ ] Dev
36-
- [ ] Test Engineering
47+
- [ ] Product Owner
48+
- [ ] Dev Owner
49+
- [ ] System Test Engineer Owner
3750

38-
# Related PR
51+
# Related PRs
3952

4053
1. PR # here
54+
55+
## Acceptance Criteria
56+
57+
Acceptance Criteria & User Stories define here (or in a separate file (linked here) for a big feature)
58+
59+
Example - https://github.com/input-output-hk/cardano-node/issues/4453

.github/ISSUE_TEMPLATE/userfacingfeature.md

-31
This file was deleted.

0 commit comments

Comments
 (0)