Stappenplan: Help Wanted

Volg dit stappenplan om een component van alle checkpoints 🚩 te voorzien die nodig zijn voor de 'Help Wanted' status van het Estafettemodel.

Naam bepaald op basis van NL Design System naamgeving

Begin met het bepalen van een naam.

Baseer de naam van de component indien mogelijk, op herkenbare termen uit webstandaarden. Liever termen uit HTML, CSS, SVG en WAI-ARIA dan uit 'UI frameworks' die op het moment populair zijn. We schrijven componenten over het algemeen als enkelvoud en met kapitalen. Bijvoorbeeld 'Accordion' of 'Text Input'.

Kijk voor inspiratie bij:

Zijn er meerdere namen voor de component? Kies de meest gangbare. De andere namen kun je later toevoegen aan de documentatie.

🚩 Checkpoint: Naam

Component kort beschreven

Doel: Vanuit het componentenoverzicht kan men de juiste component uitzoeken.

De beschrijving biedt een samenvattende omschrijving van de component, zodat deze niet met een ander verward kan worden.

Kijk ter inspiratie bij in het componentenoverzicht. Of bij de volgende design systems:

Beschrijf specifiek, kort en bondig wat de definitie is voor de component. We schrijven definities over het algemeen niet langer dan één zin, maar zeker niet meer dan een alinea.

🚩 Checkpoint: Beschrijving

Afbeelding gemaakt om de component visueel duidelijk te maken

Doel: De component is visueel duidelijk.

Om de community letterlijk een beeld te geven van de component voegen we een afbeelding toe. Het kernteam maakt deze in het Figma 'Schetsboek'. Zelf kun je een eigen afbeelding maken, huisstijl maakt niet uit.

🚩 Checkpoint: Afbeelding

Aangemaakt als een GitHub Discussion

Doel: Een plek om input te verzamelen.

We gebruiken Github 'Discussions' van NL Design System om input te verzamelen.

Start een GitHub Discussion voor de component.
Vul als titel in: {naam-component}.
Vul als beschrijving onderstaande template in en start de GitHub Discussion.

## Naam


{naam-component}


## Beschrijving


{beschrijving-component}


## Ook bekend als (niet verplicht)


{andere namen die je bent tegengekomen toen je de naam bepaalde}


## Gerelateerde componenten (niet verplicht)


{zie hieronder}


## Onderzoek

Gerelateerde componenten

Het kan voorkomen dat andere componenten sterk gerelateerd zijn aan dit component. Denk bijvoorbeeld aan Button en Action group. Dan is het handig om deze componenten naar elkaar te laten verwijzen, indien mogelijk via een link. Noteer gerelateerde componenten als volgt:

## Gerelateerde componenten


X, Y, of Z.

🚩 Checkpoint: Discussion URL

Staat in de publieke backlog van NL Design System

Doel: Zichtbaarheid en overzicht creëren zodat componenten niet dubbel worden toevoegd.

We gebruiken 'Issues' in de Github 'Backlog' repository van NL Design System om onze backlog te beheren.

Maak een 'Issue voor de component.
Vul als titel in: {naam-component}.
Vul als beschrijving onderstaande template in en maak het issue aan.

## Naam


{naam-component}


[Link naar GitHub Discussion]({link-naar-github-discussion})

Selecteer bij 'Labels' het label: Component. Selecteer bij 'Projects' het project: Components - 1 - Help Wanted.