From 0081a0b83c5e743fc5e1616199dd0a8e86edf66e Mon Sep 17 00:00:00 2001 From: Jaron Heard Date: Tue, 19 Mar 2019 00:53:37 -0700 Subject: [PATCH] Update Story Card templates --- .github/ISSUE_TEMPLATE/story-card-request.md | 69 ++++++++------------ 1 file changed, 28 insertions(+), 41 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/story-card-request.md b/.github/ISSUE_TEMPLATE/story-card-request.md index 914ffdba9..04010462f 100644 --- a/.github/ISSUE_TEMPLATE/story-card-request.md +++ b/.github/ISSUE_TEMPLATE/story-card-request.md @@ -11,44 +11,31 @@ assignees: '' **Project:** **Card Title:** - -## Description / Wireframe - -> Include a detailed description and/or image that describes your story or visualization using -> the data described below. This can be as detailed as a wireframe, or as simple as a description -> such as a bar chart that shows variable A on the X-axis and variable B on the Y-axis. - -> If you have a wireframe, include an embedded image of the card design by pasting an image from -> your clipboard or using the image uploader tool under this text box. This is mandatory before a -> front-end developer works on this ticket. - -> Also include a link to a Figma design if you have one. - -## Data Visualization / Design Concerns - -> If you have specific design or data visualization concerns, mention them here - -## Context - -> Why is this important? This information will be used to prioritize and contextualize story cards. - -## Data Details (APIs) - -> Include all API calls that will need to be made, including all params and the possible -> values for the params. The more specific the better! This will help prevent back and forth -> and ultimately make for a quicker turnaround. Also include any calculations needed for the -> data recieved from the API - -> If you do not have an API yet, it can be added later, but it is mandatory before a frontend -> developer works on this ticket. - -## About this data - -### How did we calculate this - -> Description or link to GitHub description of data methodology - -### See the source - -> Link to API / data documentation on GitHub -> Link to original source data +**Link to Card Template: [Make a copy of this template](https://docs.google.com/document/d/1aNBU5m5vc7coXbHzItJB9sUMAGufMVYEJZqXUkY40Gc/edit#)** + +## Milestones + + +### Data process: Data -> API +- [ ] Data loaded to database +- [ ] Database deployed to CIVIC Cloud +- [ ] Basic API in container +- [ ] Basic API deployed to CIVIC Cloud +- [ ] API endpoint with all needed calculations, filters and queries + + +### Data process: Data Science -> API +- [ ] Data science collaborative environment set up +- [ ] Data science results produced and documented +- [ ] Data science peer reviewed +- [ ] TBD process for peer reviewed data science results to APIs +- [ ] Data science results available through API with all needed calculations, filters and queries + +### Data visualization and Design: +- [ ] Clear concept +- [ ] All components needed available in [Storybook](https://hackoregon.github.io/civic/) +- [ ] Components available in [Storybook](https://hackoregon.github.io/civic/) demonstrate all needed features +- [ ] Follows data visualization and interface guidelines available in [Storybook](https://hackoregon.github.io/civic/) + +### Documentation: +- [ ] Documentation for source link complete