mirror of
https://github.com/fleetdm/fleet
synced 2026-05-23 08:58:41 +00:00
modify_issue_template (#9329)
This PR will change our github issues template from the previous **new-feature-work** to **Story** and **sub-task**. It can only be tested after merging to main. # Testing required: After merging this PR to main, make sure that when creating a new issue, these templates are available instead of the old one. # Checklist for submitter - [ ] Manual QA for all new/changed functionality . Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
This commit is contained in:
parent
3016ac1136
commit
f627bf43ac
3 changed files with 98 additions and 83 deletions
83
.github/ISSUE_TEMPLATE/new-feature-work.md
vendored
83
.github/ISSUE_TEMPLATE/new-feature-work.md
vendored
|
|
@ -1,83 +0,0 @@
|
|||
---
|
||||
name: 🎟 New feature work
|
||||
about: Specify a planned, new feature in Fleet so that engineering can provide an estimation on the time required for implementation.
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Problem
|
||||
|
||||
TODO
|
||||
<!--
|
||||
Motivate this feature by describing what is the user's problem.
|
||||
- Who are the affected users?
|
||||
- What is the current situation? Why does the current situation hurt?
|
||||
- What are they doing right now to resolve this issue? Why is this so bad?
|
||||
- How many users does this affect? How do you know? Share metrics or links to videos.
|
||||
-->
|
||||
|
||||
## Business Case
|
||||
|
||||
TODO
|
||||
<!--
|
||||
Why should Fleet work on this problem? How does this contribute to our reaching our strategic goals?
|
||||
-->
|
||||
|
||||
## Measurement
|
||||
TODO
|
||||
<!--
|
||||
- How will we know that the problem has been solved or improved?
|
||||
- What is the current state of the measurement?
|
||||
- What measurements do you need to implement?
|
||||
-->
|
||||
|
||||
## Requirements
|
||||
<!-- Describe the required outcomes -->
|
||||
TODO
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
<!-- Things we tend to forget about -->
|
||||
- **Documentation** Do you want a guide written about this? What things/aspects should we make sure is covered by the documentation?
|
||||
- **Transparency** Do we need to update the transparency guide to reflect new functionality?
|
||||
- **Analytics** How are we going to measure usage and success? Make sure engineering knows these need to be built.
|
||||
- **QA** Any special QA notes?
|
||||
- **Other depts.** Should other Fleet departments such as marketing, sales, CX be informed after this is shipped?
|
||||
- **Premium** Should this be a premium-only feature? If so, make sure to update the pricing page.
|
||||
|
||||
## Design
|
||||
### UI
|
||||
|
||||
TODO
|
||||
<!-- Insert the link to the relevant Figma file. Remove this section if there are no changes necessary. -->
|
||||
|
||||
### API
|
||||
|
||||
TODO
|
||||
<!-- Specify what changes to the API are required.Remove this section if there are no changes necessary. -->
|
||||
|
||||
### CLI
|
||||
|
||||
TODO
|
||||
<!-- Specify what changes to the CLI are required. Remove this section if there are no changes necessary. -->
|
||||
|
||||
## Related
|
||||
|
||||
<!-- Insert related items such as parent epic or other relevant pieces of informations -->
|
||||
|
||||
### Child issues
|
||||
|
||||
Interface team
|
||||
- TODO
|
||||
|
||||
Platform team
|
||||
- TODO
|
||||
|
||||
Agent team
|
||||
- TODO
|
||||
|
||||
Documentation
|
||||
- TODO
|
||||
68
.github/ISSUE_TEMPLATE/story.md
vendored
Normal file
68
.github/ISSUE_TEMPLATE/story.md
vendored
Normal file
|
|
@ -0,0 +1,68 @@
|
|||
---
|
||||
name: 🎟 Story
|
||||
about: Specify a Scrum user story. (e.g. "As a user, I want to sign in with SSO.")
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## User story
|
||||
|
||||
TODO
|
||||
|
||||
<!--
|
||||
Describe in a way of a user story what needs to be done, who wants it and for what purpose.
|
||||
Use this format:
|
||||
"As a _________, I want ________________."
|
||||
e.g. "As an admin I would like to be asked for confirmation before deleting a user so that I do not accidentally delete a user."
|
||||
|
||||
Things to consider:
|
||||
- Who is the human? (`As an observer…`)
|
||||
- What screen are they looking at? (`As an observer on the host details page…`)
|
||||
- What do they want to do? (`As an observer on the host details page, I want to run a permitted query.`)
|
||||
- What is the current situation? Why does the current situation hurt?
|
||||
-->
|
||||
|
||||
## Requirements
|
||||
|
||||
<!-- Things we tend to forget about -->
|
||||
- **Documentation** If the API is changing, then the [REST API docs](https://fleetdm.com/docs/using-fleet/rest-api) will need to be updated.
|
||||
- **Design changes** Does this story include changes to the user interface, or to how the CLI is used?
|
||||
- **Compatibility** Does this story require changes to the database schema and need schema migrations? Does it introduce breaking changes or non-reversible changes to Fleet's REST API or CLI usage?
|
||||
- **Premium feature** Should this be a premium-only feature? If so, make sure to update the pricing page, and that relevant code lives in the `ee/` directory.
|
||||
- **Transparency** Do we need to update the [transparency guide](https://fleetdm.com/transparency) to reflect new functionality for end users?
|
||||
- **QA** Any special QA notes?
|
||||
|
||||
|
||||
### Design
|
||||
|
||||
#### UI
|
||||
|
||||
TODO?
|
||||
<!-- Insert the link to the relevant Figma file. Remove this section if there are no changes to the user interface. -->
|
||||
|
||||
#### CLI usage
|
||||
|
||||
TODO?
|
||||
<!-- Specify what changes to the CLI usage are required. Remove this section if there are no changes to the CLI. -->
|
||||
|
||||
|
||||
### Compatibility
|
||||
#### REST API changes
|
||||
|
||||
TODO?
|
||||
<!-- Specify what changes to the API are required.Remove this section if there are no changes necessary. -->
|
||||
|
||||
#### Database schema migrations
|
||||
|
||||
TODO?
|
||||
<!-- Specify what changes to the database schema are required. Remove this section if there are no changes necessary. -->
|
||||
|
||||
## Technical sub-tasks (if any)
|
||||
N/A
|
||||
<!--
|
||||
It is simplest to use only a single user story issue. If additional issues for technical sub-tasks are necessary, they're listed here:
|
||||
- TODO
|
||||
- TODO
|
||||
-->
|
||||
30
.github/ISSUE_TEMPLATE/technical-sub-task.md
vendored
Normal file
30
.github/ISSUE_TEMPLATE/technical-sub-task.md
vendored
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
name: 🎟 Technical sub-task
|
||||
about: Specify an optional technical sub-task for a Scrum user story.
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Related user story
|
||||
|
||||
TODO
|
||||
<!-- A technical sub-task always belongs to exactly one story. The parent user story for this technical sub-task is linked here. -->
|
||||
|
||||
## Task
|
||||
|
||||
TODO
|
||||
<!--
|
||||
- What needs to be done.
|
||||
-->
|
||||
|
||||
## Condition of satisfaction
|
||||
|
||||
TODO
|
||||
|
||||
<!--
|
||||
Describe the conditions that will resolve this issue. The "definition of done".
|
||||
-->
|
||||
|
||||
|
||||
Loading…
Reference in a new issue