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

chore: update story templates #2165

Merged
merged 3 commits into from
Nov 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
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
104 changes: 60 additions & 44 deletions .github/ISSUE_TEMPLATE/99-dev-story.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Create a development story 📗
description: Story template for development tasks. Exclusively used by the onyx core team for project management.
title: "Implement|Define|Fix: ..."
title: "Implement|Define|Fix: "
projects:
- SchwarzIT/5
labels:
Expand All @@ -16,54 +16,70 @@ body:
required: true

- type: textarea
id: content
id: open-questions
attributes:
label: Content
description: Add, adapt and remove the following sections as necessary
value: >-
### Open Questions/To-dos

<!-- Remove before ready -->

<!-- [ ] Add question if any, use `@` to tag people -->

### Depends on

<!-- Add links to tickets -->

### Design

<!-- Add Figma link and comments here -->

### Acceptance criteria
label: Open questions / TODOs
value: <-- Add questions if there are any, use `@` to tag people. -->

<!-- Add ticket specific AC, e.g., the expected behavior of a component -->

### Implementation details

<!--
add details if necessary, e.g.,
- API proposal
- relevant web APIs
- learnings from other implementations
- code snippets
-->
- type: textarea
id: dependencies
attributes:
label: Depends on
description: Issues/tickets that this issue depends on.
value: "<!-- Add relevant tickets, e.g., #123 -->"

#### Reference implementations
- type: textarea
id: design
attributes:
label: Design
value: <!-- Add Figma link and comments here -->

<!-- add links to other frameworks and WaWi, examples:
- https://nuxt.com/docs/getting-started/installation
- https://element-plus.org/en-US/component/overview.html
- https://www.shadcn-vue.com/docs/components/accordion.html
- https://design-system.w3.org/components for structural inspiration
-->
- type: textarea
id: acceptance-criteria
attributes:
label: Acceptance criteria
description: Ticket specific AC, e.g., the expected behavior of a component.
value: <!-- Add ticket specific AC, e.g., the expected behavior of a component -->
validations:
required: true

#### Applicable ARIA Pattern
- type: textarea
id: implementation-details
attributes:
label: Implementation details
value: >-
<-- Add technical details / implementation proposals if necessary, e.g.:
- API proposal
- relevant web APIs
- learnings from other implementations
- code snippets
-->

<!-- add link if applicable, see https://www.w3.org/WAI/ARIA/apg/patterns -->
- type: textarea
id: reference-implementations
attributes:
label: Reference implementations
value: >-
<!-- Add links to other frameworks. Possible examples:
- [Nuxt UI](https://nuxt.com/docs/getting-started/installation)
- [Elements Plus](https://element-plus.org/en-US/component/overview.html)
- [shadcn-vue](https://www.shadcn-vue.com/docs/components/accordion.html)
- [W3C (for structural inspiration)](https://design-system.w3.org/components)
-->

### Definition of Done
- type: textarea
id: aria-pattern
attributes:
label: Applicable ARIA Pattern
value: >-
<!-- Add link to ARIA pattern if applicable, see [W3C ARIA patterns](https://www.w3.org/WAI/ARIA/apg/patterns/) -->

- type: textarea
id: definition-of-done
attributes:
label: Definition of Done
description: For more details, please refer to our [documentation](https://onyx.schwarz/principles/definition-of-done.html).
value: >-
- The following component requirements are implemented:
- [ ] skeleton
- [ ] density
Expand All @@ -77,10 +93,10 @@ body:
- [ ] Storybook code snippet of new/changed examples are checked that they are generated correctly
- [ ] Namings are aligned with Figma

**Approval**
#### Approval

- Storybook <!-- add link to deployed storybook -->
- Deployed Docs <!-- add link to deployed docs -->
- [Storybook](<!-- LINK HERE -->)
- [Documentation](<!-- LINK HERE -->)
- [ ] approved by designer <!-- add your @username -->
- [ ] approved by dev <!-- add your @username -->
validations:
Expand Down
65 changes: 37 additions & 28 deletions .github/ISSUE_TEMPLATE/99-ux-story.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Create a UX story 🎨
description: Story template for design tasks. Exclusively used by the onyx core team for project management,
title: "Concept|Adjust|Research: ..."
title: "Concept|Adjust|Research: "
projects:
- SchwarzIT/5
labels:
Expand All @@ -10,50 +10,59 @@ body:
- type: textarea
id: description
attributes:
label: Description
description: Add a short description and motivation for the story.
validations:
required: true

- type: textarea
id: content
attributes:
label: Content
description: Add, adapt and remove the following sections as necessary
label: Create Component
description: Add, adapt and remove the following as necessary
value: >-
### Create "Component Name"

- [ ] _if needed_ variation
- [ ] density
- [ ] states
- [ ] dark mode
- [ ] keyboard support
validations:
required: true

### Functions

- type: textarea
id: functions
attributes:
label: Functions
description: Add possible Functions
value: >-
- [ ] function 1
- [ ] function 2
- [ ] function 3

### Figma

- [ ] dev handover
- [ ] ux component

### documentation
- type: textarea
id: figma
attributes:
label: Figma
value: >-
- [ ] UX component

- type: textarea
id: documentation
attributes:
label: Documentation
value: >-
- [ ] keyboard support
- [ ] property description
- [ ] textual documentation
- [ ] component grouping
validations:
required: true

### _if needed_ links for comparison

- link 1
- link 2

### Finalizing
- type: textarea
id: comparison
attributes:
label: Comparison
value: ""

- [ ] approved
- type: textarea
id: finalizing
attributes:
label: Finalizing
description: "The issue is approved by the following designers and developers:"
value: >-
- [ ] approved by designer <!-- add your @username -->
- [ ] handover and approved by dev <!-- add your @username -->
validations:
required: true
Loading