-
Notifications
You must be signed in to change notification settings - Fork 211
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create an issue template for component specifications (#369)
- Loading branch information
Showing
1 changed file
with
54 additions
and
0 deletions.
There are no files selected for viewing
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,54 @@ | ||
--- | ||
name: Component spec | ||
about: Describe a new component to be developed for the design system | ||
labels: "🕹 aspect: interface, 🌟 goal: addition, 🚦 status: awaiting triage, 🟨 priority: medium" | ||
title: "<Replace this with the component name>" | ||
--- | ||
|
||
## Component: Title | ||
<!-- Replace 'Title' above with the actual component title. --> | ||
|
||
## Description | ||
<!-- Describe the component, including different states. Do not include screenshots. --> | ||
|
||
## API | ||
<!-- Tentatively specify the props, state and emitted events of the component. --> | ||
|
||
### Props | ||
<!-- Describe possible props and their types; or delete the section if the component takes no props. --> | ||
|
||
| Name | Type | Description | | ||
|-|-|-| | ||
|
||
### Slots | ||
<!-- Describe slots with expected content and slot props; or delete the section if the component exposes no slots. --> | ||
|
||
| Name | Slot props | Description | | ||
|-|-|-| | ||
|
||
### State | ||
<!-- Describe possible state fields and types; or delete the section if the component is stateless. --> | ||
<!-- Include information about Vuex state or getters, if any. --> | ||
|
||
| Name | Type | Description | | ||
|-|-|-| | ||
|
||
### Events | ||
<!-- Describe possible events and their associated data; or delete the section if the component emits no events. --> | ||
<!-- Include information about Vuex mutations or actions, if any. --> | ||
|
||
| Name | Associated data | Description | | ||
|-|-|-| | ||
|
||
## Code samples | ||
<!-- Share pseudocode templates or high-level implementation code; or delete the section entirely. --> | ||
|
||
## References | ||
<!-- Include as many references to prior art as you deem necessary or helpful. --> | ||
|
||
<!-- Place a link to the Figma node of the component from the Design Library: https://www.figma.com/file/GIIQ4sDbaToCfFQyKMvzr8/Openverse-Design-Library --> | ||
- **Figma:** | ||
|
||
## Implementation | ||
<!-- Replace the [ ] with [x] to check the box. --> | ||
- [ ] 🙋 I would be interested in implementing this component. |