Code standards

Voor het schrijven van onze code hebben we een aantal regels opgesteld.

1. Functie en variabelen moeten een duidelijke naam hebben. Deze naam moet goed weergeven wat de functie doet of wat variabele inhoudt.
2. Functies en variabelen worden in camelCase geschreven. Een variabel genaamd current user wordt dus currentUser.
3. Het gebruik van var is absoluut verboden! Er mag alleen gebruik worden gemaakt van let en const.
4. Overbodige comments of console logs mogen niet in de code worden achtergelaten.
5. Al de code moet worden ondersteund met comments wanneer dit nodig is. De comments moeten het doel van de code belichten.
6. Een tab is in ons geval twee spaties.
7. Elke regel code moet worden afgesloten met een puntkomma.
8. Al de bestanden moeten in de correcte mappen worden geplaatst. Routes in de routes folder, css bestanden in de css folder, etc.
9. Er wordt in javascript code gebruik gemaakt van enkele quotes in plaats van enkele quotes.

Deze regels zullen voor een deel worden gecontroleerd door onze linter ESLint en formatter Prettier. De regels hiervoor staan in onze repository opgenomen in het .prettierrc en het .eslintrc bestand. We hebben ervoor gekozen om door te gaan met de formatter en linter uit het individuele project van Stein. Hierdoor hoefde de bestaande code zo min mogelijk worden aangepast.