Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the issue templates #4555

Merged
merged 1 commit into from
Oct 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Bug report
about: Report a bug to help us improve
title: "[BUG] - "
labels: bug
labels: "type: bug"
assignees: ''

---
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Feature request
about: Submit a feature request
title: "[FR] - "
labels: enhancement
labels: "type: enhancement"
assignees: ''

---
Expand Down
57 changes: 38 additions & 19 deletions .github/ISSUE_TEMPLATE/user-facing-feature.md
Original file line number Diff line number Diff line change
@@ -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
<!-- What the end user will see -->

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

## Personas - Who will this affect?
## Personas
<!-- Who will this affect? -->

- [ ] 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)
dorin100 marked this conversation as resolved.
Show resolved Hide resolved
- [ ] 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
31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/userfacingfeature.md

This file was deleted.