Skip to content

Commit

Permalink
docs: update github issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
blackfalcon committed Jul 31, 2020
1 parent 4670f3f commit e7d6d98
Show file tree
Hide file tree
Showing 10 changed files with 221 additions and 5 deletions.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/audit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Component Audit
about: Crate a new component audit ticket for tracking
title: 'Component Name Here ...'
---

# Component Audit

The scope of this issue is to track the full progress of the (name) component.

<!-- template content, do not remove -->
## Process

This issue is to remain open until all areas of the specification and all assets have been delivered to stakeholders and user groups.

As new issues are created that are children of this Audit item, please be sure to reference this Audit item in that issue.

As assets are delivered, it is required that the labels associated with this Audit issue are updated to reflect status. Labels are as follows:

- Artwork
- Code
- Docs
- Ui Kit

This Audit issue will remain open until all assets have been delivered be it V0 or ADS compliment.
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
title: 'auro-[name]: [issue summary]'
labels: 'Type: Bug'
assignees: blackfalcon

---

## Describe the bug
Expand Down
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/develop-design-story.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
name: Development Story
about: Crate a new user story to address the development process
title: 'auro-[name]; develop [feature]'
labels: 'Status: Backlogged'
---

# User story

As a [persona], I want to be able to [intent, not feature(s)], so I can [describe benefit].

## Outline subtasks or tasks

> List specific steps required to deliver this work.
- [ ] Address all design and UX as proposed in the design comp in relation to using Auro specifications
- [ ] A11y in regards to role and live notifications need to be coded into the final WC
- [ ] Review demo with the designer as well as the Auro team
- [ ] All new work to be reviewed by Auro team

## Definition of “Done” (exit criteria)

> The story is generally “done” when the user can complete the outlined task, but make sure to define what that is.
#### Has been tested in all browsers

- [ ] Chrome
- [ ] Firefox
- [ ] Edge (79 +)
- [ ] Safari
- [ ] Mobile Safari
- [ ] IE11

#### Has been tested for accessibility

- [ ] Screenreader
- [ ] Axe
- [ ] Keyboard use

#### Performance

- [ ] Chrome Lighthhouse report

#### Auro component features

- [ ] README doc completed with all relative information
- [ ] API documentation created
- [ ] Bundled version tested and documented
- [ ] Examples and use case info created
- [ ] Pages added to the Auro Doc Site


## Audit

https://github.com/AlaskaAirlines/auro/issues/[issue number]
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
title: 'auro-[name]: [feature summary]'
labels: 'Type: Feature'
assignees: blackfalcon

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/general-support.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: General support
about: Suggestions that are not related to bugs or new features
title: ''
title: 'As a [user] I need help with [issue]'
labels: 'Type: Question'
assignees: blackfalcon

Expand Down
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/new_wc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Component Request
about: Request new Web Compomnent work
title: 'auro-[prposed name]: requeisted new compomnent'
labels: 'Status: In discovery'
assignees: blackfalcon

---

## What is the requested web component?

> Please provide a short description of the proposed web component
## Features

> Please list out the features of the proposed web component
1. ...
1. ...
1. ...
1. ...

## Is there any prior art related to this proposal?

- [ ] YES
- [ ] NO

### Prior art

> If YES to the question above, please list all URLs to prior art and/or attach screen shots for review.
## Agreement

By checking the box below I acknowledge that the proposed web component does not duplicate any existing feature or functionality within the Auro Design System. The proposal is requesting support for a feature that is currently not supported.

- [ ] I certify that this proposal does not replicate any existing design or functionality.

## Additional context

> Please list any other additional information you see necessary to communicate the scope of the proposed web component.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/parent-design-story.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Parent Design Story
about: Crate a new user story as the parent manager of child design and dev stories
title: 'auro-[name]; design [feature]'
labels: 'Status: Backlogged'
---

# User story

As a [persona], I want to be able to [intent, not feature(s)], so I can [describe benefit].

## Outline subtasks or tasks

> List specific steps required to deliver this work.
- [ ] ...
- [ ] ...

## Definition of “Done” (exit criteria)

> The story is generally “done” when the user can complete the outlined task, but make sure to define what that is.
- [ ] Backlogged
- [ ] Discovery
- [ ] Design
- [ ] Review [story](must link to child story)
- [ ] Production
- [ ] Symbolizing [story](must link to child story)
- [ ] Complete

## Audit

https://github.com/AlaskaAirlines/[repository]/issues/[issue number]
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/review-design-story.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Review Design Story
about: Crate a new user story to address the design review process
title: 'auro-[name]; design [feature] review'
labels: 'Status: Backlogged'
---

# User story

As a UI designer of Auro, I want to be able to review the work, so I can give feedback and prepare for next steps.

## Outline subtasks or tasks

> List specific steps required to deliver this work.
- [ ] review work as presented by the product designer
- [ ] provide feedback
- [ ] prepare for next steps of development and symbolize

## Definition of “Done” (exit criteria)

> The story is generally “done” when the user can complete the outlined task, but make sure to define what that is.
This story will be considered done when the presented work has been approved and prepared for dev work and symbolization.

### reference

https://github.com/AlaskaAirlines/[repository]/issues/[issue number]
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/symbol-design-story.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Symbolize Design Story
about: Crate a new user story to address the symbol creation process
title: 'auro-[name]; design [feature] symbolize'
labels: 'Status: Backlogged'
---

# User story

As a designer, I want to be able to have access to a symbolized version, so I can easily reuse with my project.

## Outline subtasks or tasks

> List specific steps required to deliver this work.
- [ ] Add completed work to UI Kit as Sketch Symbol

## Definition of “Done” (exit criteria)

> The story is generally “done” when the user can complete the outlined task, but make sure to define what that is.
- [ ] the documented design spec has been created
- [ ] assets have been symbolized in the UI toolkit
- [ ] new UI has been applied to the WC

#### reference

https://github.com/AlaskaAirlines/[repository]/issues/[issue number]
10 changes: 9 additions & 1 deletion .github/ISSUE_TEMPLATE/user-story.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ about: Crate a new user story for a unit of work
title: ''
labels: 'Status: Proposal'
assignees: blackfalcon

---

# User story
Expand Down Expand Up @@ -49,5 +48,14 @@ As a [persona], I want to be able to [intent, not feature(s)], so I can [describ
#### Performance
- [ ] Chrome Lighthhouse report
-->

<!-- Use the following template for doc site-related exit criteria
#### Auro component features
- [ ] README doc completed with all relative information
- [ ] API documentation created
- [ ] Bundled version tested and documented
- [ ] Examples and use case info created
- [ ] Pages added to the Auro Doc Site
-->

0 comments on commit e7d6d98

Please sign in to comment.