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.

Sign up for GitHub

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

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

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
59e3e57
Create a Design Doc issue template
marcaaron Jan 17, 2023
3d207a2
add @stitesExpensify awesome suggestions
marcaaron Jan 18, 2023
4f68480
Update .github/ISSUE_TEMPLATE/DesignDoc.md
marcaaron Jan 18, 2023
8832920
Apply suggestions from code review
marcaaron Jan 18, 2023
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
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/DesignDoc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
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
- [ ] Wait at least one full business day, and until the post has a majority (2/3) of positive reactions (👍)
- [ ] Paste Proposal in the space above with a link to the Slack thread
- [ ] Email `strategy@expensify.com` and paste in the Proposal
- [ ] Fill out **High-level overview of the problem**, **Timeline**, and **Terminology** sections of the Design Doc
- [ ] Email `strategy@expensify.com` (same email chain as before) with the link to your Design Doc
- [ ] Host a **pre-design** meeting ([example](https://expensify.slack.com/archives/C01GTK53T8Q/p1665794669539419)) in `#expensify-open-source` to discuss any necessary details in public before filling out the **High-level of proposed solution** section.
- [ ] 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 the `DesignDocReview` label to get the **High-level of proposed solution** section reviewed
- [ ] Respond to any questions or concerns and bring up blockers in Slack to get a consensus if necessary
- [ ] 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.
- [ ] Re-add the `DesignDocReview` label
- [ ] 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
- [ ] Send out a follow up email to `strategy@expensify.com` once everything has been implemented and do a **Project Wrap-Up** retrospective that provides:
- Summary of what we accomplished with this project
- What went well?
- What could we have done better?
- What did we learn?