Refine user story template (#12819)

Based on our last product/eng sync. Slimming down the fields so it's
less daunting and separating the checkboxes into each department.

The expectation would be that each list is fully complete before passing
to the next step (product > engineering > product quality). ..

---------

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
This commit is contained in:
Luke Heath 2023-07-21 19:54:17 -07:00 committed by GitHub
parent d6c556f914
commit 36ffc63755
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -21,22 +21,24 @@ assignees: ''
## Changes
This issue's estimation includes completing:
### Product
- [ ] UI changes: TODO <!-- Insert the link to the relevant Figma file describing all relevant changes. Remove this checkbox if there are no changes to the user interface. -->
- [ ] CLI usage changes: TODO <!-- Specify what changes to the CLI usage are required. Remove this checkbox if there are no changes to the CLI. -->
- [ ] REST API changes: TODO <!-- Specify what changes to the API are required. Remove this checkbox if there are no changes necessary. -->
- [ ] Permissions changes: TODO <!-- Specify what changes to the permissions are required. Remove this checkbox if there are no changes necessary. -->
- [ ] Database schema migrations: TODO <!-- Specify what changes to the database schema are required. (This willl be used to change migration scripts accordingly.) Remove this checkbox if there are no changes necessary. -->
- [ ] Outdated documentation changes: TODO <!-- Specify what changes to the documentation are required. Remove this checkbox if there are no changes necessary. -->
- [ ] Scope transparency changes? TODO <!-- Remove this checkbox if there are no changes necessary. -->
- [ ] Breaking changes requiring major version bump? TODO <!-- Breaking changes to the CLI or REST API require a major version bump, which is rarely a good idea. Remove this checkbox if there are no changes necessary. -->
- [ ] Changes to paid features or tiers? TODO <!-- List changes to paid features or tiers required. Implementation of paid features should live in the `ee/` directory. Remove this checkbox if there are no changes necessary. -->
- [ ] QA complete?
- [ ] Changes to paid features or tiers TODO <!-- List changes to paid features or tiers required. Implementation of paid features should live in the `ee/` directory. Remove this checkbox if there are no changes necessary. -->
### Engineering
- [ ] REST API changes: TODO <!-- Specify what changes to the API are required. Remove this checkbox if there are no changes necessary. Product may move this item to the list above if they choose to design the API changes. -->
- [ ] Database schema migrations: TODO <!-- Specify what changes to the database schema are required. (This willl be used to change migration scripts accordingly.) Remove this checkbox if there are no changes necessary. -->
- [ ] Documentation changes complete
### Product quality
- [ ] QA complete
- [ ] ... <!-- If there are any other notable requirements to draw extra attention to, add them as checkboxes here. Otherwise, remove this checkbox. -->
>  Please read this issue carefully and understand it. Pay [special attention](https://fleetdm.com/handbook/company/development-groups#developing-from-wireframes) to UI wireframes, especially "dev notes".
## Context
- Requestor(s): _________________________ <!-- Who are the non-customer requestor(s) for this story, if any? Put their github usernames here. They should be notified if the story gets de-prioritized. For customer requestors, use the `customer-xyz` label instead. -->
<!--
@ -45,21 +47,13 @@ What else should contributors [keep in mind](https://fleetdm.com/handbook/compan
2.
-->
## QA
### Risk assessment
- [ ] Requires load testing TODO <!-- User story has performance implications that require load testing. Otherwise, remove this checkbox. -->
Risk level: Low / High TODO <!-- Choose one. -->
Risk description: TODO <!-- If risk level is high, explain why. If low, remove. -->
#### Automated:
- Fleet: Cover / Will not cover <!-- Choose one. -->
- QAWolf: Cover / Will not cover <!-- Choose one. -->
- Requires load testing: TODO <!-- User story has performance implications that require load testing. Otherwise, remove this item. -->
- Risk level: Low / High TODO <!-- Choose one. -->
- Risk description: TODO <!-- If risk level is high, explain why. If low, remove. -->
### Manual testing steps
<!--