Afspraken, best practices en code conventies

[Jason2426]

Belangrijke afspraken, best practices en code conventies voor een vloeiende samenwerking.

Code conventies

• Mobile First
• Kebab-case in html en css
• CamelCase in javascript
• Witregel na sections zodat code goed leesbaar
• Semantisch HTML(Divs & spans als tags wel iets betekenen maar je er niet uitkomt.)
• Comments aan complexe code toevoegen of eventueel link met issue

Best practices

• Atomic design methodology voor ontwerp en bouwen
• DRY methode / Component based
• Na het maken van een component het gelijk testen op toegankelijkheid, performance en responsiveness en dit ook documenteren in de betreffende pull request.
• Pull requests uitgebreid schrijven Voorbeeld / 2dejaars, wat de code doet, testresultaten, foto's voor en na en hoe het beoordeeld moet worden.
• Pull request minimaal 1 reviewer.

Afspraken

• Dinsdag of Donderdag eventueel een check-in call en elkaar helpen waar nodig.
• Communicatie via teams indien hulp nodig.
• Elke dag op school even de voortgang bespreken en samen kijken wat er gedaan moet worden (Soort standup).

Branches

• Voor branches gebruiken we kebab-case

• feature of fix / component-naam

Voorbeeld : Feature/navbar-layout of Fix/Reduce-spacing

[yujing-student]

een atom is voor mij onder andere de subscribe component iets wat je overal kan hergebruiken

een molecule is voor mij onder andere het searchbar component dat op de memberspagina staat

een Organisms is een groep dat bij elkaar hoort dus de cards zijn een molecule en omdat het in een grid layout staat is het members component een organism

dit is voor mij het overzicht hoe ik het zou indelen

organism: header,footer, member

molecule: intro section, vacancy,cards

atoms: subscribe, link, vacancies

[yujing-student]

functional layering

we gaan deze methode aanhouden omdat dit het beste aansluit op ons project

display daarin zie je alles wat informatie toont input: dat is interactief navigation: daar zit alles van de navigatie in