From 68c8a9db8a82ffdab341428cfd9786a09c082edd Mon Sep 17 00:00:00 2001 From: dorin100 Date: Thu, 27 Oct 2022 13:48:42 +0300 Subject: [PATCH] Update the issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- .github/ISSUE_TEMPLATE/user-facing-feature.md | 57 ++++++++++++------- .github/ISSUE_TEMPLATE/userfacingfeature.md | 31 ---------- 4 files changed, 40 insertions(+), 52 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/userfacingfeature.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 4d7f01e124c..a7d51658be3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -2,7 +2,7 @@ name: Bug report about: Report a bug to help us improve title: "[BUG] - " -labels: bug +labels: "type: bug" assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 5fe277b4c75..52609ce24c6 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,7 +2,7 @@ name: Feature request about: Submit a feature request title: "[FR] - " -labels: enhancement +labels: "type: enhancement" assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/user-facing-feature.md b/.github/ISSUE_TEMPLATE/user-facing-feature.md index 1c75d187df2..1f54e1bc7b9 100644 --- a/.github/ISSUE_TEMPLATE/user-facing-feature.md +++ b/.github/ISSUE_TEMPLATE/user-facing-feature.md @@ -1,40 +1,59 @@ --- name: User facing feature -about: For internal use -title: '' -labels: '' +about: For internal use only; Open a user-facing feature tracking file +title: "[FEATURE] - " +labels: ["type: internal-feature", "user type: internal"] assignees: '' --- -## What - The user facing feature being implemented +## What + ## Why + -## Personas - Who will this affect? +## Personas + -- [ ] SPO -- [ ] Dapp Devs +- [ ] SPOs +- [ ] dApp Devs - [ ] Exchanges +- [ ] Wallets +- [ ] 3rd party tools +- [ ] ADA holders -## Acceptance Criteria - -## Definition of done +## Definition of Done (DoD) -- [ ] Code review +- [ ] [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) - [ ] Builds successfully on CI -- [ ] Includes documentation and/or examples for the functionality +- [ ] Code & Test review (as per Acceptance Criteria) +- [ ] There is documentation and/or examples for the new functionality (usage/response) - [ ] Log/record changes on **Vnext** (or similar depending on what we adopt) -- [ ] Ticket number included in PR description -- [ ] The new functionality is covered by dev/unit/property tests -- [ ] Acceptance Criteria met -- [ ] Test Engineering Sign-off + E2E automated tests +- [ ] Ticket number(s) included in PR description +- [ ] All Acceptance Criteria met and covered by dev/unit/property/integration tests +- [ ] System/E2E automated tests + System Test Engineer Owner Sign-off + +> **_NOTE:_** Ideally, we should merge only fully implemented and tested features into the master branch. +> So all the above steps are required for the PR to be merged. +> In order to avoid the PRs becoming stale and requiring to be rebased on master, these can be merged +> after a reasonable time (current agreement is 3 days) if the System Test Engineer Owner's sign-off +> was not provided (last step in the DoD). + +> **_IMPORTANT:_** Any deviation from the plan should be discussed and agreed as a comment in the Feature file. ## Sign-off -- [ ] Dev -- [ ] Test Engineering +- [ ] Product Owner +- [ ] Dev Owner +- [ ] System Test Engineer Owner -# Related PR +# Related PRs 1. PR # here + +## Acceptance Criteria + +Acceptance Criteria & User Stories define here (or in a separate file (linked here) for a big feature) + +Example - https://github.com/input-output-hk/cardano-node/issues/4453 diff --git a/.github/ISSUE_TEMPLATE/userfacingfeature.md b/.github/ISSUE_TEMPLATE/userfacingfeature.md deleted file mode 100644 index b374bfb9f44..00000000000 --- a/.github/ISSUE_TEMPLATE/userfacingfeature.md +++ /dev/null @@ -1,31 +0,0 @@ -## What - The user facing feature being implemented - -## Why - -## Personas - Who will this affect? - -- [ ] SPO -- [ ] Dapp Devs -- [ ] Exchanges - -## Acceptance Criteria - -## Definition of done - -- [ ] Code review -- [ ] Builds successfully on CI -- [ ] Includes documentation and/or examples for the functionality -- [ ] Log/record changes on **Vnext** (or similar depending on what we adopt) -- [ ] Ticket number included in PR description -- [ ] The new functionality is covered by dev/unit/property tests -- [ ] Acceptance Criteria met -- [ ] Test Engineering Sign-off + E2E automated tests - -## Sign-off - -- [ ] Dev -- [ ] Test Engineering - -# Related PR - -1. PR # here \ No newline at end of file