You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: versnel het aanmaken van stories in candidate repo tijdens voorbereidingsfase (#1038)
Onderdeel van #1037
waarin we doen:
- Verplaats "Maak de packages beschikbaar voor de nieuwe Candidate
component" van "Varianten bepaald" naar "Keywords en aliassen bepaald".
- Verbeter "Maak de packages beschikbaar voor de nieuwe Candidate
component" met de learnings van Form Field Label.
- Verbeter "Maak de packages beschikbaar voor de nieuwe Candidate
component" met uitleg over het nieuwe script.
---------
Co-authored-by: Charlotte Gieltjes <charlotte.gieltjes@rebels.io>
@@ -14,7 +15,6 @@ Component is, waar nodig, versimpeld of opgesplitst. Zodat er één of meerdere
14
15
-[ ] Verzamel input uit de Community
15
16
-[ ] Besluit welke varianten Candidate worden
16
17
-[ ] Documenteer besluit in de GitHub Discussion
17
-
-[ ] Maak de packages beschikbaar voor de nieuwe Candidate component
18
18
-[ ] Documenteer besluit in de Candidate repository
19
19
-[ ] Zet de checkpoint in het GitHub projectbord op de juiste status
20
20
@@ -118,24 +118,6 @@ Voorbeeld hypothese voor RVO met 4 verschillende formaten voor font-size:
118
118
- Bepaal samen met de Design System Lead welke varianten in de Candidate component moeten worden opgenomen
119
119
- Notuleer de besproken beredeneringen op, deze heb je nodig in de volgende stap.
120
120
121
-
### Maak de packages beschikbaar voor de nieuwe Candidate component
122
-
123
-
Het is vanaf dit moment handig dat er een omgeving is waarin de component en al zijn aanhangsels kan worden ontwikkeld. Maak dus in [de Candidate repository](https://github.com/nl-design-system/candidate) de packages alvast aan voor
124
-
125
-
- de css component
126
-
- de react component
127
-
- de component docs
128
-
129
-
Maak daarnaast alvast de mapjes aan:
130
-
131
-
- het mapje voor deze component in storybook-test
132
-
- het mapje voor deze component in storybook-non-conforming
133
-
- het mapje voor deze component in storybook
134
-
135
-
#### Hoe doe je dit bijvoorbeeld
136
-
137
-
Er is hiervoor een experimenteel script beschikbaar in de Candidate repository. `scripts/create-package.sh`. Deze kun je in je terminal draaien, waarbij je kunt aangeven om welke component het gaat etc. Op basis hiervan worden template bestanden en mapjes aangemaakt die je in de volgende stappen kunt vullen.
138
-
139
121
### Documenteer besluit
140
122
141
123
- Optioneel: splits, in overleg met de Design System Lead, de component op in meerdere componenten en zet de extra componenten met logica die we daarin gaan opnemen op de Backlog.
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/204-📝-keywords-en-aliassen.md
+55-12Lines changed: 55 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,39 +1,84 @@
1
1
---
2
2
name: Kernteam - 📝 Keywords en aliassen bepaald
3
-
4
3
about: Keywords en aliassen voor de component zijn bepaald zodat deze makkelijk kan worden gevonden
5
-
title: '{component-name} - 📝 Keywords en aliassen bepaald
6
-
'
4
+
title: '{component-name} - 📝 Keywords en aliassen bepaald'
7
5
labels:
8
6
- 📝 Candidate Voorbereidingsfase
9
7
- designer relations
10
8
- developer relations
9
+
type: Task
11
10
---
12
11
13
12
## 📝 Keywords en aliassen bepaald
14
13
14
+
-[ ] Maak de packages beschikbaar voor de nieuwe Candidate component
15
15
-[ ] Verzamel alternatieve namen voor de component
16
+
-[ ] Stem af met Design System Lead
16
17
-[ ] Voeg de meest gebruikte alternatieven toe aan de component pagina in de candidate repository
17
18
-[ ] Voeg de aliassen toe aan de keywords op de component pagina in de documentatie repository
18
19
-[ ] Zet de checkpoint in het GitHub projectbord op de juiste status
19
20
21
+
### Maak de packages beschikbaar voor de nieuwe Candidate component
22
+
23
+
Het is vanaf dit moment handig dat er een omgeving is waarin de component en al zijn aanhangsels kan worden ontwikkeld. Maak dus in [de Candidate repository](https://github.com/nl-design-system/candidate) de packages alvast aan voor:
24
+
25
+
- de css component
26
+
- de react component
27
+
- de component docs
28
+
- de tokens
29
+
30
+
Maak daarnaast alvast de mapjes en bestanden aan voor deze component in:
31
+
32
+
- storybook-test
33
+
- storybook-non-conforming
34
+
- storybook
35
+
36
+
#### Hoe doe je dit bijvoorbeeld
37
+
38
+
Er zijn hiervoor scripts beschikbaar in de Candidate repository: `scripts/create-package.sh` en `scripts/create-stories.sh`. Deze kun je in je terminal draaien, waarbij je kunt aangeven om welke component het gaat etc. Op basis hiervan worden template bestanden en mapjes aangemaakt die je in de volgende stappen kunt vullen.
39
+
40
+
```shell
41
+
scripts/create-package.sh css button "Biedt de mogelijkheid om een actie uit te voeren.""Provides the ability to perform an action."
42
+
scripts/create-package.sh react button "Biedt de mogelijkheid om een actie uit te voeren.""Provides the ability to perform an action."
43
+
scripts/create-package.sh docs button "Biedt de mogelijkheid om een actie uit te voeren.""Provides the ability to perform an action."
44
+
scripts/create-package.sh tokens button "Biedt de mogelijkheid om een actie uit te voeren.""Provides the ability to perform an action."
Diverse design systems, Developers en Designers gebruiken verschillende woorden om hetzelfde component mee aan te duiden. Tijdens de Help Wanted fase is de naam van de component bepaald, maar door keywords en aliassen toe te voegen kan de component ook op de namen die we zelf niet gebruiken gevonden worden. Voor de componenten is er op Slack een uitgebreide lijst 'Component Keywords & Aliassen' waar we deze in eerste instantie in verzamelen.
23
58
24
59
#### Hoe kun je dit bijvoorbeeld doen?
25
60
26
-
- Maak een Canvas aan
27
-
- Maak een nieuwe Mentimeter wordcloud aan voor de component.
28
-
- Haal input op bij Designers en Developers uit de community door te vragen hoe zij de component ook wel noemen.
29
-
- Voeg de uitkomsten aan de canvas toe aan de kolom met 'Keywords' en noteer achter elk woord hoevaak deze werd genoemd.
61
+
Verzamel input:
62
+
63
+
- Verzamel de huidige keywords voor deze component. Deze vind je in het Slack Canvas "[Component Keywords & Aliassen](https://codefornl.slack.com/docs/T68FXPFQV/F07BH78SAFP)" of in de keywords van de detail pagina van deze component in de documentatie repository. Noteer de resultaten in een comment in de issue.
64
+
- Haal input op bij Designers en Developers uit de community door te vragen hoe zij de component ook wel noemen. Bijvoorbeeld middels een Mentimeter WordCloud quiz tijdens een Open Hour. Noteer de resultaten in een comment in de issue.
65
+
- Verzamel welke keywords en andere gebruikte woorden voorkomen in het vakgebied. Je vind relevante bronnen in het Slack Canvas "[Inspiratie- en referentiebronnen voor componenten](https://codefornl.slack.com/docs/T68FXPFQV/F0AEQ1Q0WBS)". Noteer de resultaten in een comment in de issue.
66
+
67
+
Maak een voorstel:
68
+
69
+
- Combineer de resultaten in en tel op hoevaak ze voorkomen.
30
70
- Selecteer de 0 tot 5 meest genoemde keywords en voeg deze toe aan de kolom met 'Aliassen'. Nummer de lijst op volgorde van meest naar minst vaak genoemd.
31
-
- Zijn er duidelijk veelgebruikte alternatieven die ook als je een zoekmachine (google) gebruikt tot resultaten leiden? Ga dan verder met het toevoegen van de Aliassen.
71
+
- Zijn er duidelijk veelgebruikte keywords die ook als je een zoekmachine (Google) gebruikt tot resultaten leiden? Neem deze ook op in Aliassen.
72
+
- Stem met Design System Lead af.
73
+
74
+
Verwerk de uitkomsten:
75
+
76
+
- Voeg de uitkomsten aan de canvas toe aan de kolom met 'Keywords' en noteer achter elk woord hoevaak deze werd genoemd.
77
+
- Voeg de uitkomsten aan de canvas toe aan de kolom met 'Aliassen' genummerd van meest naar minst vaak genoemd.
32
78
33
79
### Voeg de meest gebruikte alternatieven toe aan de component pagina in de candidate repository
34
80
35
-
- Voeg een bestand genaamd aliases.md toe binnen de docs folder van de component. Deze folders vind je binnen de docs folder van de Candidate repository in GitHub. :new: Bestaat deze folder nog niet? Bekijk hoe je deze aanmaakt en wat er in moet komen te staan in .
36
-
- Voeg de aliassen toe aan het bestand. Gebruik hiervoor de volgende opzet:
81
+
- Voeg de aliassen toe aan het bestand `aliases.md` in de component docs package in de Candidate repository in GitHub. Gebruik hiervoor de volgende opzet:
37
82
38
83
```md
39
84
<!-- @license CC0-1.0 -->
@@ -48,8 +93,6 @@ Maak een PR aan gebruik hierbij de volgende opzet:
48
93
-**Commit Message**: `docs: candidate aliases for {naam-component}`
0 commit comments