-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Add DEV and UX issue templates (#2104)
- Added [Issue templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms) for Dev and UX tickets to make ticket creation process easier - Renamed templates to enforce wanted order of issue templates
- Loading branch information
Showing
4 changed files
with
120 additions
and
0 deletions.
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
--- | ||
name: Create a Dev Story 📗 | ||
about: Story Template for development tasks | ||
title: 'Implement|Define|Fix: ...'' | ||
labels: 'dev' | ||
|
||
--- | ||
|
||
<!-- Add, adapt and remove the following sections as necessary --> | ||
|
||
### Open Questions/To-dos | ||
|
||
<!-- Remove before ready --> | ||
|
||
<!-- [ ] Add question if any, use `@` to tag people --> | ||
|
||
### Depends on | ||
|
||
<!-- Add links to tickets --> | ||
|
||
### Why? | ||
|
||
<!-- Add description and motivation --> | ||
|
||
### Design | ||
|
||
<!-- Add Figma link and comments here --> | ||
|
||
### Acceptance criteria | ||
|
||
<!-- 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 | ||
--> | ||
|
||
#### Reference implementations | ||
|
||
<!-- 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 | ||
--> | ||
|
||
#### Applicable ARIA Pattern | ||
|
||
<!-- add link if applicable, see https://www.w3.org/WAI/ARIA/apg/patterns --> | ||
|
||
### Definition of Done | ||
|
||
- The following component requirements are implemented: | ||
- [ ] skeleton | ||
- [ ] density | ||
- [ ] example usage added to `apps/demo-app/src/views/HomeView.vue` | ||
- covered by tests | ||
- [ ] functional tests (Playwright or unit test) | ||
- [ ] visual tests (Playwright screenshots) | ||
- [ ] follow-up tickets were created if necessary | ||
- [ ] updated version + documentation is deployed | ||
- [ ] Storybook can show the feature | ||
- [ ] Storybook code snippet of new/changed examples are checked that they are generated correctly | ||
- [ ] Namings are aligned with Figma | ||
|
||
**Approval** | ||
|
||
- Storybook <!-- add link to deployed storybook --> | ||
- Deployed Docs <!-- add link to deployed docs --> | ||
- [ ] approved by designer @jannick-ux | ||
- [ ] approved by dev <!-- add dev tag --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
name: Create a UX Story 🎨 | ||
about: Story Template for design tasks | ||
title: 'Concept|Adjust|Research: ...'' | ||
labels: 'ux' | ||
|
||
--- | ||
|
||
<!-- Add, adapt and remove the following sections as necessary_ --> | ||
|
||
### Create "Component Name" | ||
|
||
- [ ] _if needed_ variation | ||
- [ ] density | ||
- [ ] states | ||
- [ ] dark mode | ||
- [ ] keyboard support | ||
|
||
### Functions | ||
|
||
- [ ] function 1 | ||
- [ ] function 2 | ||
- [ ] function 3 | ||
|
||
### Figma | ||
|
||
- [ ] dev handover | ||
- [ ] ux component | ||
|
||
### documentation | ||
|
||
- [ ] keyboard support | ||
- [ ] property description | ||
- [ ] textual documentation | ||
- [ ] component grouping | ||
|
||
### _if needed_ links for comparison | ||
|
||
- link 1 | ||
- link 2 | ||
|
||
### Finalizing | ||
|
||
- [ ] approved |