Studentassistenten-Windesheim / ASVS-for-dummies

1 stars 1 forks source link

Link naar de https://asvs-for-dummies.pages.dev/ site toevoegen #33

Open KoenvanMeijeren opened 5 months ago

KoenvanMeijeren commented 5 months ago

Op dit moment is het lastig om de asvs-for-dummies site te vinden. Daarom wil ik adviseren om hier SEO optimalisatie voor te inbouwen en deze link toe te voegen aan de description van deze repository.

Definition of Done (click to expand)

### Globaal - [ ] ESLint geeft geen fouten; - [ ] Code in het Engels; (eventueel Nederlands bij formele begrippen) - [ ] Code voorzien van commentaar, waar noodzakelijk. - [ ] Camelcasing, startend met een kleine letter. Geldt ook voor bestandsnamen. Alleen classes beginnen met een hoofdletter. - [ ] Errorhandling is toegepast op basis van error-helpers en de beschrijving hiervan op de wiki: [Try catch error handling](https://gitlab.com/teamlynn/tasker/wikis/Architectuur/Error-handling). - [ ] Er is **geen console.log aanwezig**, alleen de centrale [logging](https://gitlab.com/teamlynn/tasker/wikis/Architectuur/Logging). - [ ] Code is efficiënt: dubbele code is minimaal. ### Testen Zie de [Cypress best practises](https://docs.cypress.io/guides/references/best-practices) voor meer informatie over de onderstaande criteria en hoe je ze waarborgt. ##### Algemeen - [ ] Testen zijn geschreven volgens de [Cypress conventies](https://docs.cypress.io/guides/references/best-practices) - [ ] specs ([naam].cy.ts) zijn per pagina opgesteld en dekken alle functionaliteit van die pagina. - [ ] Testen zijn '[flake-free](https://www.jetbrains.com/teamcity/ci-cd-guide/concepts/flaky-tests/)' . Run de testen dus niet slechts 1x lokaal voor je het commit, maar meerdere malen. - [ ] Er is geen statische text getest(hardcoded text dat niet veranderd, zoals een titel van een dialoog), de testen beperken zich tot dynamische content. - [ ] Commands zijn alleen gemaakt voor herhalende code over meerdere specs. Als code alleen binnen één spec voorkomt, kan daar een normale functie voor komen. - [ ] Alle testen slagen in de pipeline. - [ ] Testperformance is optimaal. Geen onnodige [waits](https://docs.cypress.io/api/commands/wait) en (trage) UI-handelingen die programmatisch kunnen. - [ ] Handelingen worden alleen via de UI uitgevoerd wanneer de test die specifieke handeling test. Anders kan dit programmatisch. - [ ] Url's zijn getest op pathname en responsecode(dat de url correct is, betekent niet dat de pagina goed ingeladen is). Hier is een custom command voor. - [ ] Maak gebruik van [cy.context](https://docs.cypress.io/guides/core-concepts/writing-and-organizing-tests#Test%20Structure) om testen te categoriseren. ##### Fixtures - [ ] Bestaande fixtures zijn niet aangepast als ze in gebruik zijn door andere tests - [ ] Fixtures hebben beschrijvende namen, BV: projectWithStudentsAndCollaborators. - [ ] Na het aanmaken van nieuwe fixtures is de config aangevuld (config.ts & config.json) ##### Data-cy - [ ] Voor het aanspreken van html-elementen zijn enkel en alleen data-cy attributen gebruikt. - [ ] Data-cy attributen zijn in kebab-case en zonder hoofdletters. - [ ] Entiteit-specifieke parameters (zoals id of naam) zijn top-level toegevoegd(bijvoorbeeld aan een overkoepelende Div of een Tr). - [ ] Data-cy attributen met Entiteit-specifieke parameters zijn volgens dit format: [parameter]-[omschrijving(optioneel)] BV: "Reversi-row" - [ ] Child elementen hebben generieke namen, zoals: 'edit-project' of 'delete-episode'. - [ ] Query elementen alleen met data-cy, probeer het elementtype weg te laten, dus niet: ‘**a**[data-cy=”new-project”]’, maar: ‘[data-cy=”new-project”]’