webcomponenten-vl-ui

GitHub issues GitHub pull requests GitHub release (latest SemVer)

Een overzicht van de webcomponenten met bijhorende API en demo's, gepubliceerd via de demo pagina. De webcomponenten-vl-ui-bom dependency kan gebruikt worden als bill of materials (BOM).

API

De API van elke webcomponent worden gepubliceerd via de demo pagina.

Demo

De demo pagina bevat een overzicht van de mogelijkheden met code voorbeelden. Lokaal opstarten kan met onderstaand NPM script.

$ npm run demo

Publicatie

Om een nieuwe webcomponenten pagina te publiceren kan het generate script uitgevoerd worden.

$ npm run generate

Testen

De webcomponent bevat verschillende unit testen die bij elke commit geautomatiseerd in Chrome en Firefox draaien. Hierdoor kunnen we bij elke release een minimum aan kwaliteit garanderen. Later zullen er ook nog UI testen toegevoegd worden zodat al de functionaliteit uitgebreid getest wordt.

De testen kunnen lokaal opgestart worden met onderstaand NPM script.

$ npm run test

Issues

Indien je nood hebt aan extra feature of een bug gevonden hebt, mag je hiervoor een issue aanmaken. Er zijn 3 issues templates beschikbaar:

Feature request
Bug
Task

Uiteraard is het ook toegelaten om mee te ontwikkelen door gebruik te maken van Pull Requests (PR). Gelieve volgende conventies te respecteren:

Bug issue best linken aan een branch met een test die het probleem illustreert zodat de bug opgelost kan worden
Elke commit die betrekking heeft tot een issue moet een verwijzing hiernaar hebben vb. #33 fix uitlijning header
Elke PR moet een issue verwijzing hebben, zodat deze automatisch opgenomen kan worden in de release notes

Versionering

We gebruiken Semantic Versioning en voorzien elke release van release notes, zie een overzicht van de releases.

Browser ondersteuning

De webcomponenten zijn ontwikkeld door uitsluitend gebruik te maken van web standaarden (JavaScript, HTML, CSS). Hierdoor worden al de evergreen browser automatisch ondersteund.