-
Notifications
You must be signed in to change notification settings - Fork 1
Conventies
"Committing often is very useful. It’s useful to commit every time you write code that you want to keep. You can even use temporary commits with messages such as "wip" (work in progress)."
Commit early and often, push once (a day)
De afspraak is dat de ieder lid van een team elke dag (waarop aan het teamproject wordt gewerkt) een pull request doet naar de fdnd-agency/release-candidate branch van hun project. De docenten / co-teachers reviewen de pull requests.
"The Boy Scout Rule advocates for continuous improvement in code quality with each change made. Rather than waiting for designated cleanup periods, developers strive to leave the codebase better than they found it, even if it’s just a small enhancement."
The Girl / Boy Scout Rule in Software Development
"Have you ever wondered what makes a good README? The kind that stands out, draws you in, and most importantly, helps you understand the project?"
How to write a perfect readme for your GitHub project
- Gebruik betekenisvolle namen voor classes, id's, variables en function namen.
- Gebruik altijd Engels in naamgeving!
- Gebruik gestructureerde en semantische HTML
- Nest content niet onnodig diep. Voorkom te diepe nesting van section elementen en daarmee gepaarde heading levels. Link waar nodig liever naar een andere url met meer informatie
- Maak gebruik van ingebouwde features van HTML (bijvoorbeeld de krachtige form validation van formulier elementen)
- Zorg voor logische secties in je stylesheet
- Werk van generiek naar specifiek
- Maak zoveel mogelijk gebruik van de cascade en inheritance, en gebruik utility classes om onnodig herhaling van code te voorkomen (DRY)
- Maak slim gebruik van custom properties voor nettere code
- gebruik kebab-case voor de naamgeving van classes en id's
- Gebruik een vaste indeling van code per scope en maak daarbij gebruik van het JavaScript principe hoisting:
// 1. declare all variables for the specific scope
// 2. all code logic
// 3. function declarations - gebruik camelCase voor de naamgeving van bindings (variables & function declarations)