Skip to content

Latest commit

 

History

History
48 lines (27 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

48 lines (27 loc) · 2.73 KB
Raw

Com Contribuir

Ens encanta rebre contribucions de la nostra comunitat i el públic, i agraïm el vostre interès en col·laborar! Aquí teniu algunes directrius que us ajudaran a contribuir amb èxit al nostre projecte de visualització de dades obertes.

Codi de Conducta

Aquest projecte s'adhereix a un codi de conducta, i en participant esteu d'acord en complir els seus termes. Per a més informació, consulteu el fitxer CODE_OF_CONDUCT.md.

Començant

  1. Familiaritzeu-vos amb el projecte. Dediqueu una estona a llegir la documentació per comprendre millor què fem i com ho fem.

  2. Instal·lació local. Seguiu les instruccions del fitxer README.md per establir un entorn de desenvolupament local. Això us permetrà treballar amb el codi i realitzar canvis sense afectar l'entorn de producció.

Realitzar Contribucions

Podeu contribuir de diverses maneres:

  • Millorant la documentació: Clarifiqueu els manuals, afegiu comentaris al codi, o milloreu el README.md.

  • Reportant errors: Utilitzeu la secció 'Issues' per reportar qualsevol error que trobeu. Descriu el problema i afegeix detalls que puguin ajudar els altres a reproduir l'error i corregir-lo.

  • Proposant noves funcionalitats: Si teniu idees per a noves funcionalitats o millores, obriu un 'Issue' nou i parlem-ne.

  • Enviant 'pull requests': Les vostres propostes de canvis en el codi són benvingudes.

    • Fes Fork del repositori: Primer, fes un fork del projecte al teu compte de GitHub.
    • Crea una branca: Crea una branca per a cada contribució.
    • Fes els teus canvis: Realitza els teus canvis de manera local.
    • Comprova el codi: Assegura't que el teu codi segueixi les guies d'estil del projecte.
    • Envia la Pull Request (PR): Envieu la vostra PR amb una descripció clara dels canvis i qualsevol altra informació que ajudi als revisors a entendre la vostra contribució.

Directrius per a 'Pull Requests'

  • Manteniu les PR petites: Les PR que són petites i fàcils de revisar tenen més probabilitats de ser acceptades.

  • Inclou tests: Si és possible, afegiu tests que validin els canvis que heu fet.

  • Documenteu els canvis: Assegureu-vos que totes les modificacions estiguin adequadament documentades, especialment si introduïu noves funcionalitats.

  • Segueixi les convencions de codi: El codi hauria de ser net i fàcil de llegir, amb comentaris quan sigui necessari.

Recursos

  • Readme: Per a instruccions d'instal·lació i dependències, consulteu el README.md.
  • Issues: Per a reportar errors o discutir millores, utilitzeu la secció 'Issues' del repositori.

Gràcies per contribuir al nostre projecte. Esperem amb entusiasme les vostres aportacions!