Skip to content

Commit

Permalink
Merge pull request #432 from hackoregon/storycard-template
Browse files Browse the repository at this point in the history
Update Story Card templates
  • Loading branch information
jaronheard authored Apr 12, 2019
2 parents ffbc460 + 0081a0b commit ce24675
Showing 1 changed file with 28 additions and 41 deletions.
69 changes: 28 additions & 41 deletions .github/ISSUE_TEMPLATE/story-card-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<!-- Remove if using data science results -->
### 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

<!-- Remove if not using data science results -->
### 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

0 comments on commit ce24675

Please sign in to comment.