Code conventies

Code Conventions en Afspraken

Design

• Sitemap: Creëer een overzichtelijke sitemap.
• Wireframe & Wireflow: Ontwikkel wireframes en wireflows om de gebruikerservaring te visualiseren.
• Breakdown: Deel het ontwerp op in kleinere, beheersbare onderdelen.

HTML

• Semantisch: Gebruik semantische HTML-elementen voor betere leesbaarheid en toegankelijkheid.
• Mobile First: Bouw de website met een mobile-first aanpak.
• Herbruikbare Componenten: Maak gebruik van herbruikbare HTML-componenten om consistentie te waarborgen.

CSS

• Kebab-case: Gebruik kebab-case voor het benoemen van klassen en ID's.
• Nesting: Pas nesting toe in CSS voor duidelijke structuur.
• Variabelen: Gebruik CSS-variabelen voor consistentie en eenvoud in aanpassingen.
• Custom Properties: Maak gebruik van custom properties om stijlbeheer te vergemakkelijken.
• Gebruiksvriendelijk (Accessibility): Zorg ervoor dat de CSS bijdraagt aan een toegankelijke en gebruiksvriendelijke interface.

JavaScript

• camelCase: Volg de camelCase conventie voor het benoemen van variabelen en functies.
• Herbruikbare Functies: Schrijf herbruikbare functies om code efficiënt te maken.
• Comments: Voeg duidelijke en nuttige comments toe om de code beter begrijpbaar te maken.

Algemene Afspraken

• Progressive Enhancement: Bouw alles met het oog op progressive enhancement, zodat de kernfunctionaliteit altijd werkt, zelfs in minder geavanceerde omgevingen.
• Partials: Features worden ontwikkeld in partials voor beter onderhoud en modulariteit.
• Schone Code: Zorg ervoor dat de code schoon en overzichtelijk is.
• Duidelijke Namen: Geef klassen en ID's duidelijke en beschrijvende namen.
• Samenwerken: Vraag elkaar om hulp als iets niet werkt; we helpen elkaar.

Branches, commits en pull-requests

Branches

Bij het maken van grotere feature maken we gebruik van een branche. Een branche is een aftak van de main branche. Op die manier heb je geen problemen met het committen en pushen van je werk.

Pull-requests

Om je feature te pushen maak je een pull-request. Hierdoor kan je gemakkelijk je werk met de main branche mergen. In je pull-request staat het volgende:

• Titel
• Korte beschrijving van je feature
• Belangrijke dingen om te weten

Hierna zal je pull-request worden bekeken door minimaal 1 persoon.

Commits

Initialen - [Label] [Korte Beschrijving]

Labels:

• Added
• Changed
• Removed
• Undo
• Redo
• Clean-up

Voorbeeld JK - Added HTML skeleton