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

[NO QA] Create a Design Doc issue template #14380

Merged
merged 4 commits into from
Jan 18, 2023
Merged
Changes from 1 commit
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
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/DesignDoc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Design Doc tracking issue
about: A standard template to follow when leading a project
labels: Daily, NewFeature
---

## Proposal

## Tasks

- [ ] Post **Proposal (Problem/Solution)** in #expensify-open-source
marcaaron marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Paste Proposal in the space above with a link to the Slack thread
- [ ] Email `strategy@expensify.com` and paste in the Proposal
marcaaron marked this conversation as resolved.
Show resolved Hide resolved
JmillsExpensify marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Fill out **High-level overview of the problem**, **Timeline**, and **Terminology** sections of the Design Doc
marcaaron marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Email `strategy@expensify.com` (same email chain as before) with link to Design Doc
stitesExpensify marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Host a _pre-design_ meeting in `#expensify-open-source` to discuss any necessary details in public before filling out the **High-level of proposed solution** section
stitesExpensify marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Fill out the **High-level of proposed solution** section
- [ ] Email `stategy@expensify.com` again with links to the doc and pre-design conversation in Slack
- [ ] Add `DesignDocReview` label to get the **High-level of proposed solution** section reviewed
stitesExpensify marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Respond to any questions or concerns and bring up blockers in Slack to get consensus if necessary
stitesExpensify marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Confirm that the doc has the minimum necessary number of reviews before proceeding
- [ ] Host another pre-design meeting in `#expensify-open-source` to ask for engineering feedback on the technical solution.
- [ ] Fill out the **Detailed implementation of the solution** and related sections.
marcaaron marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Re-add the `DesignDocReview`
stitesExpensify marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Respond to any questions or concerns and bring up blockers in Slack to get consensus if necessary
- [ ] Confirm that the doc has the minimum necessary number of reviews before proceeding
- [ ] Email `strategy@expensify.com` one last time to let them know the Design Doc is moving into the implementation phase
- [ ] Implement the changes
marcaaron marked this conversation as resolved.
Show resolved Hide resolved