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

Documentation: tracking component design or behaviour change #285

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/component-design-update.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Component design or behaviour change
description: Track implementation of design update to an existing Compound component
title: |
Design update: [PLATFORM] [COMPONENT]
labels: [T-Enhancement, X-Design-Change]
body:
- type: markdown
attributes:
value: |
This template is intended for designers to request design changes in components already implemented in
Compound Web, Android or iOS.
If you would like to request a new component, please use the new component template.
If you are not a designer and would like to request a new component or a change to an existing component,
please use the enhancement template.
- type: textarea
id: description
attributes:
label: Description
description: |
What components and variants are affected.
Detailed changelog (changed, added, removed)
Screenshots
placeholder: Describe the changes
validations:
required: true
- type: input
id: figma
attributes:
label: Figma link
validations:
required: true
- type: dropdown
id: platform
attributes:
label: Platform
description: |
If this change should be applied to multiple platforms, please create multiple issues
options:
- "Web"
- "iOS"
- "android"
validations:
required: true
6 changes: 6 additions & 0 deletions stories/design/contributing.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ Components are systematised in Compound when they’re used in the Element user
- Create [an issue](https://github.com/vector-im/compound/issues/new/choose) using the _New component_ issue template, filling out the component name and Figma linking
- The newly created issue is then automatically added to the [Components board](https://github.com/orgs/vector-im/projects/52/views/18) where progress is tracked

### Tracking changes to an existing component

When design or behaviour changes to an existing component are ready to be handed over to an engineer to implement:
- create [an issue](https://github.com/vector-im/compound/issues/new/choose) using the *Component design or behaviour change*
template.

### Contributing a colour style

- Optimise for personal velocity in your designs by using semantic tokens where they exist, and base tokens where they don't
Expand Down