From 1a5d1e80e07bc4a395b196fd82b119daf733281f Mon Sep 17 00:00:00 2001 From: noahtalerman <47070608+noahtalerman@users.noreply.github.com> Date: Wed, 10 Mar 2021 16:39:53 -0800 Subject: [PATCH] Project issue template v2 (#442) This PR includes changes to the internal project issue template. - The template now requests more when describing the problem the project is trying to solve and why the stated problem is important. - More flexibility for how the project's solution is described and how the solution's implementation is planned. --- .github/ISSUE_TEMPLATE/z-new-project.md | 45 +++---------------------- 1 file changed, 4 insertions(+), 41 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/z-new-project.md b/.github/ISSUE_TEMPLATE/z-new-project.md index 51bd1b8136..76fcb16f92 100644 --- a/.github/ISSUE_TEMPLATE/z-new-project.md +++ b/.github/ISSUE_TEMPLATE/z-new-project.md @@ -9,47 +9,10 @@ assignees: '' ### Goal -> TODO: A sentence or two describing the high level goal for this project +> TODO: A sentence describing the problem this project is trying to solve. i.e. What is the user trying to achieve? -### Estimated release date +> TODO: A sentence describing the "so what" for this project. i.e. Why do they want to solve the above problem? What's the overall benefit the user is trying to achieve? -> TODO: When we expect to release some or all of these improvements +### Solution -### Steps - -- I. Drafting - - [x] High-level goals, estimated release date set - - [x] This GitHub issue - - [ ] Consider impact to UX/DX, talk to users - - [ ] **If applicable:** Visual design - - [ ] Design research - - [ ] Lo-fi wireframes (personal draft in Figma) - - [ ] Vision review w/ @edamamedesign, directional/aesthetic revisions - - [ ] Practical review w/ @mikermcneil, simplifying/UX revisions - - [ ] Hi-fi wireframes (shared project in Figma) - - [ ] Engineering review w/ @zachw, tactical revisions - - [ ] Final wireframes - - [ ] Shared as a comment in this issue -- II. Implementation - - [ ] Pull request(s) - - [ ] Code changes - - [ ] Documentation changes - - [ ] Short Loom video demo (the happy path + the edge cases you've tested) - - [ ] Engineering review, quality/style revisions -- III. Release - - [ ] Release tagged - - [ ] Release notes written - - [ ] Upgrade considerations documented (e.g. breaking change, DB schema migrations, etc) - - [ ] Release announced - - [ ] Code published - - [ ] GitHub - - [ ] NPM - - [ ] Docker - - [ ] Release blog post published - - [ ] Release announced… - - [ ] …in osquery Slack - - [ ] …on social media - - [ ] https://twitter.com/fleetctl - - [ ] https://linkedin.com/company/fleetdm - - [ ] https://www.facebook.com/fleetdm - - [ ] https://www.instagram.com/fleetctl/ +> TODO: Attach any wireframes, mockups, screenshots, or just describe the planned or possible solution. \ No newline at end of file