From f627bf43acd2ff9f0a88f4ad6c6f0ac0390d0efc Mon Sep 17 00:00:00 2001 From: Sharon Katz <121527325+sharon-fdm@users.noreply.github.com> Date: Fri, 13 Jan 2023 18:37:02 -0500 Subject: [PATCH] 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 --- .github/ISSUE_TEMPLATE/new-feature-work.md | 83 -------------------- .github/ISSUE_TEMPLATE/story.md | 68 ++++++++++++++++ .github/ISSUE_TEMPLATE/technical-sub-task.md | 30 +++++++ 3 files changed, 98 insertions(+), 83 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/new-feature-work.md create mode 100644 .github/ISSUE_TEMPLATE/story.md create mode 100644 .github/ISSUE_TEMPLATE/technical-sub-task.md diff --git a/.github/ISSUE_TEMPLATE/new-feature-work.md b/.github/ISSUE_TEMPLATE/new-feature-work.md deleted file mode 100644 index 1abd7ceca6..0000000000 --- a/.github/ISSUE_TEMPLATE/new-feature-work.md +++ /dev/null @@ -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 - - -## Business Case - -TODO - - -## Measurement -TODO - - -## Requirements - -TODO -1. -2. -3. - - -- **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 - - -### API - -TODO - - -### CLI - -TODO - - -## Related - - - -### Child issues - -Interface team -- TODO - -Platform team -- TODO - -Agent team -- TODO - -Documentation -- TODO diff --git a/.github/ISSUE_TEMPLATE/story.md b/.github/ISSUE_TEMPLATE/story.md new file mode 100644 index 0000000000..31e3e27f95 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/story.md @@ -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 + + + +## Requirements + + +- **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? + + +#### CLI usage + +TODO? + + + +### Compatibility +#### REST API changes + +TODO? + + +#### Database schema migrations + +TODO? + + +## Technical sub-tasks (if any) +N/A + diff --git a/.github/ISSUE_TEMPLATE/technical-sub-task.md b/.github/ISSUE_TEMPLATE/technical-sub-task.md new file mode 100644 index 0000000000..df39d5485a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/technical-sub-task.md @@ -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 + + +## Task + +TODO + + +## Condition of satisfaction + +TODO + + + +