E-sites actief op GitHub

Door E-sites, E-sites
25 januari 2013 - 1885 x bekeken - Categorieën: Tech

Wij developers bij E-sites zijn al een behoorlijke tijd fan van de community, maar vanaf nu zijn we ook als organisatie actief op GitHub! Op dit populaire open-source platform gaan we allerlei in-huis ontwikkelde scripts, die we standaard inzetten in onze oplossingen, delen met de rest van het wereldwijde web.

Meer transparantie

Een van onze doelstellingen in 2013 is om de front-end afdeling meer op de kaart te zetten voor de buitenwereld en nog meer laten zien waar we allemaal mee bezig zijn. Kortom: meer transparantie.

Naast het plaatsen en onderhouden van intern ontwikkelde scripts op GitHub hebben we tevens een groot deel van onze front-end documentatie online gezet voor klanten en andere geïnteresseerden.

Wat je hier zoal kan vinden is onze productiefilosofie, interne front-end afspraken en een overzicht met deovereenkomsten die deze afspraken hebben met de webrichtlijnen van de overheid. Binnenkort zullen we in een aparte blogpost verder inhaken op deze bron van front-end informatie.

Social Coding

Voor degene die niet- of minder bekend zijn met GitHub; GitHub is een community waar men code kan delen met vrienden, collega’s, klasgenoten en onbekenden. GitHub biedt zowel gratis als betaalde accounts voor open-source projecten en is, met drie miljoen gebruikers wereldwijd, de meest populaire hostingsite gebaseerd op Git.

Een handig feature is het profileren (en beheren) van je organisatie op GitHub. Binnen een organisatie kan je teams aanmaken waar je individuele developers aan toe kan voegen. Hier hebben we als E-sites uiteraard handig gebruik van gemaakt!

Kwaliteit waarborgen

Vanzelfsprekend gaan we niet ieder willekeurig script op GitHub plaatsen, het gaat hier tenslotte ook om onze reputatie. Om het proces in goede banen te leiden zijn we de laatste druk tijd bezig geweest met de voorbereidingen om bepaalde zaken te standaardiseren. Een belangrijk aspect hiervan zijn onze interne GitHub richtlijnen, ieder script wat op GitHub gehost gaat worden dient hier aan te voldoen. Een aantal van deze regels zijn:

  • het script moet generiek van opzet zijn;
  • zorg voor een nette (en consistente) coding stijl;
  • zorg voor een demo.html (of index.html) waarin een aantal demo's van je script te vinden zijn;
  • zorg ervoor dat deze demo’s ook te bekijken zijn op github.E-sites.nl;
  • het script is conform de interne JSHint richtlijnen;
  • zorg altijd voor een minified productie versie van je script;
  • zorg voor een Engelse README.md file met beknopte documentatie van het script;
  • zorg voor de juiste license files (MIT en GPL);
  • zorg voor unit tests:
    • minimaal 10 tests
    • deze tests zijn onderdeel van de repository en dienen in een aparte 'tests' map geplaatst te worden
    • als unit-test framework kan jQuery's Qunit gebruikt worden;
  • er dient een code review plaats te vinden door een senior front-end developer.

JSend

Als eerste open-source project hebben we JSend toegevoegd, een handige tool die bijdraagt aan het standaardiseren van alle AJAX communicatie in je front-end code.

Selenium – (geautomatiseerd) testen als een gebruiker

Door Sam de Poorter

Een professionele applicatie moet op zijn minst een degelijke testprocedure doorstaan. Gelukkig is het tijdperk van botweg handmatig testen voorbij… - Lees meer

Lees verder