|
1 | 1 | ---
|
2 | 2 | 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"] |
6 | 6 | assignees: ''
|
7 | 7 |
|
8 | 8 | ---
|
9 | 9 |
|
10 |
| -## What - The user facing feature being implemented |
| 10 | +## What |
| 11 | +<!-- What the end user will see --> |
11 | 12 |
|
12 | 13 | ## Why
|
| 14 | +<!-- The reason why this user-facing feature is being implemented --> |
13 | 15 |
|
14 |
| -## Personas - Who will this affect? |
| 16 | +## Personas |
| 17 | +<!-- Who will this affect? --> |
15 | 18 |
|
16 |
| -- [ ] SPO |
17 |
| -- [ ] Dapp Devs |
| 19 | +- [ ] SPOs |
| 20 | +- [ ] dApp Devs |
18 | 21 | - [ ] Exchanges
|
| 22 | +- [ ] Wallets |
| 23 | +- [ ] 3rd party tools |
| 24 | +- [ ] ADA holders |
19 | 25 |
|
20 |
| -## Acceptance Criteria |
21 |
| - |
22 |
| -## Definition of done |
| 26 | +## Definition of Done (DoD) |
23 | 27 |
|
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) |
25 | 29 | - [ ] 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) |
27 | 32 | - [ ] 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. |
32 | 44 |
|
33 | 45 | ## Sign-off
|
34 | 46 |
|
35 |
| -- [ ] Dev |
36 |
| -- [ ] Test Engineering |
| 47 | +- [ ] Product Owner |
| 48 | +- [ ] Dev Owner |
| 49 | +- [ ] System Test Engineer Owner |
37 | 50 |
|
38 |
| -# Related PR |
| 51 | +# Related PRs |
39 | 52 |
|
40 | 53 | 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 |
0 commit comments