- Bij een bug vermeld een korte beschrijving in de titel.
- vermeld de exception class bv. "System.Exception"
- velmeld de message als die er is.
- vermeld de hele stack.
- vermeld hoe de crash of bug was ontstaan.
- vermeld bij de label dat het een bug is.
alle push moeten naar hun eigen branch met een beschrijvende naam. Dat betekent dat je niet meteen naar de master mag of kan push dit zal een error verorzaken bij de client.
een push request is hier voor nodig. een of meerderen contributers kunnen hun opmerking achterlaten. er mag geen request changes tussen zitten om te mergen. ook moet er een review van de code owner bij zitten. de approve wordt automatisch verwijderd wanneer jij je code update.
daarnaast moeten het up to date zijn, moet ook de build halen en kan geen conflicts hebben.
na de merge is de test ook nog niet over er kunnen nog issues bij komen. maar de branch word na de merge verwijderd.
- Er word gewerkt binnen het project met de programmeertaal PHP.
- Het project wordt ontwikkeld binnen Laravel.
- Benamingen moeten altijd beschrijvend zijn. Ze beschrijven het doel wat het ding (variabele naam) aanduidt.
- Alle namen zijn in het Engels.
- De namen moeten specifiek zijn.
- De namen moeten uitspreekbaar zijn.
- Namen mogen alleen de volgende karakters bevatten: a-z, A-Z en _ (underscore).
- Namen die uit één word bestaan, worden voluit getypt.
- Als de naam uit meerdere woorden bestaat, dan is een afkorting mogelijk, maar alleen als de afkorting duidelijk is in de context. Alleen een woord afkorten als het meer dan drie karakters bespaard.
- Alle code word gecontroleerd volgens het testplan.
- De namen van klasse zijn altijd in enkelvoud. Bijvoorbeeld: Student, Car, Person.
- Wanneer de naam van een klasse uit meerdere woorden bestaat, wordt elk woord met een hoofdletter geschreven.
- Een korte uitleg is aanwezig boven het desbetreffende stuk code om dit nader te verklaren.
- De commentaar die bij de code wordt geschreven zal in het Engels geschreven worden.
- Commentaar word kort en bondig geschreven.
- Documenten worden online bewaard op Github in mapje docs
- Documenten worden geschreven in het Nederlands
- Documenten beginnen met een Titelblad.
- Documenten worden geschreven in Arial.
- Tekst binnen documenten hebben lettertype 12.
- Titels van documenten hebben lettertype 16.
- Alle documenten worden gecontroleerd volgens het testplan.