Deze guidelines beschrijven de regels waar de code die geschreven wordt tijdens dit project aan moeten voldoen. Er kan afgeweken worden van deze regels als er een erg goede reden voor is, maar over het algemeen worden deze regels eigenlijk altijd gevolgd.
1.1. Code
- Java code is geschreven in overeenkomst met de Java code conventions.
- Er is gekeken of de IDE geen op- of aanmerkingen heeft over de geschreven code. Het is echter niet zo dat alles wat de IDE zegt klopt dus controleer dit altijd even.
- SQL Code is geschreven in overeenkomst met de SQL Code conventions (Hoofdstuk 7)
- Variabelnamen, klassenamen en methodenamen worden in het Engels genoteerd.
- Tabelnamen, kolomnamen, variabelnamen, stored procedure namen en andere gerelateerde namen in het Engels.
1.2. Git
- Er wordt niet gecommit naar de main
...
- branch, in plaats daarvan wordt er gecommit naar de feature-branch.
- De git omgeving wordt opgezet in de volgende hiërarchische volgorde:
- master
- development
- feature-branch
- Aanpassingen aan deze branches gebeuren alleen met pull-requests.
- Pull-requests mogen alleen gemerged worden als een andere teamgenoot ernaar gekeken heeft.
- Git commit berichten bevatten in het kort wat er is aangepast of wat er is toegevoegd
- Git commit berichten beginnen met een hoofdletter en eindigen met een punt.
1.3. Bestandsnamen
...
- Bestandsnamen bevatten geen spaties.
- Bestandsnamen zijn geschreven in UpperCamelCase
1.4. Wireframes
- Alle wireframes zijn tenminste
...
- medium fidelity wireframes