Skip to content

Commit

Permalink
Create an issue template for component specifications (#369)
Browse files Browse the repository at this point in the history
  • Loading branch information
dhruvkb authored Oct 27, 2021
1 parent 02226b9 commit 127af29
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/component_spec.md
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.

0 comments on commit 127af29

Please sign in to comment.