https://civictechro.github.io/guidelines/
CivicTech România își dorește să folosească potențialul tehnologiei Open Source și talentul specialiștilor români pentru a dezvolta noi servicii digitale de utilitate publică.
Tocmai de aceea am creat și acest ghid, pentru a stabili împreună cum putem colabora la dezvoltarea acestor proiecte și pentru a strânge în jurul nostru o comunitate de oameni cu aceeași viziune ca și noi. În redactarea acestor guidelines ne-am folosit de experiența dobândită în mediul privat și de bunele practici promovate acolo, dar și de experiența de până acum în CivicTech România și GovITHub.
Aceste guidelines sunt în continuă dezvoltare, folosind ca sursă de inspirație The US Digital Services Playbook, GitHub Open Source Guides dar și setul de guidelines dezvoltat inițial în cadrul GovITHub. Așteptăm propunerile voastre pe GitHub!
Conținutul este compilat din fișiere Markdown, folosind Jekyll.
Dacă vrei să rulezi site-ul local, va trebui să instalezi Jekyll și dependințele sale.
- Dacă nu ai deja Ruby și Bundler instalate, urmărește cei doi pași pentru instalare.
- Apoi, ai nevoie de un fork al acestui repository pe care îl poți clona local.
- Din root-ul proiectului, pe calculatorul tău, poți rula
bundle installîn terminal.
Pentru a rula site-ul local, rulează jekyll serve --watch din terminal, apoi deschide http://localhost:4000/ în browser.
Proiectul folosește Sass pentru management de CSS. Codul îl poți găsi în styles.scss file. Folosim suportul SASS nativ pentru Jekyll pentru a genera fișierele CSS, când rulezi site-ul local.
Dacă vrei să propui o schimbare, trimite un pull request, cu o schimbare într-unul dintre fișierele Markdown. Fiecare guideline se poate găsi în folderul _plays. Introducerea se află în folderul _include.
Fișierele se pot edita și direct în browser, fără a fi necesară instalarea de software adițional.
- Proiectul trebuie să conțină un fișier README.md în care să apară informații relevante despre proiect.
- Cerințele și specificațiile trebuie să fie prezente în proiect. Dacă nu sunt, deschide un issue pe Github.
- Codul trebuie scris în engleză (e.g.: numele variabilelor).
- Componentele care interacționează cu utilizatorul trebuie să suporte localizarea în diferite limbi.
- Conținutul în limba română trebuie să folosească diacritice.
- Toate proiectele trebuie să aibă o copie a licenței folosite.
- Menționează canalul de Slack al proiectului în README.
- Prezența și rularea testelor nu este opțională.
- Documentația trebuie scrisă în timpul dezvoltării, nu după.
CivicTech România este construit cu ajutorul voluntarilor.
Made with ❤️ & ☕ by CivicTech România