Contribuir al projecte

Contribuir al projecte

Quan s'envia una contribució, s'ha d'identificar clarament el titular dels drets d'autor i incloure la declaració de concessió de llicències aplicables. Recordar que per a ser acceptada, la contribució ha de tenir una llicencia igual que la resta del document, a saber, la versió de la GPL 3 o superior.

Les contribucions al projecte, com ara traduccions i pegats, són molt benvingudes. Qualsevol persona pot fer un lliurament directe al repositori. No obstant això, demanem que s'enviïn els canvis grans a la llista de correu per a parlar-ne en primer lloc. Veure la secció Contacte per a més informació.

El ${project} utilitza Git com a sistema de control de versions i gestió de codi font. Com s'explica en Repositoris Git hi ha dues branques principals de desenvolupament: debian i debian-next. Tothom pot fer lliuraments a les branques debian-next dels repositoris live-boot, live-build, live-config, live-images, live-manual i live-tools.

No obstant això, hi ha certes restriccions. El servidor rebutja:

●  Push que no són fast-forward.

●  Commits merge.

●  Afegir o eliminar etiquetes o branques.

Tot i que tots els lliuraments poden ser revisats, demanem que s'utilitzi el sentit comú i es facin bons lliuraments amb bons missatges.

●  Escriure missatges de lliurament que consisteixen en oracions completes i significatives en anglès, començant amb una lletra majúscula i acabant amb un punt. En general, aquests començaran amb la forma 'Fixing/Adding/Removing/Correcting/Translating/...'.

●  Escriure bons missatges de lliurament. La primera línia ha de ser un resum exacte dels continguts del lliurament, que s'inclourà en la llista de canvis. Si es necessita fer algunes explicacions més, escriure a sota deixant una línia en blanc després de la primera línea i després una altra línia en blanc després de cada paràgraf. Les línies dels paràgrafs no han de superar els 80 caràcters de longitud.

●  Fer lliuraments de manera atòmica, és a dir, no barrejar coses no relacionades en el mateix lliurament. Fer un lliurament diferent per a cada canvi que es faci.

Fer canvis

Per tal de fer un push als repositoris, s'ha de seguir el següent procediment. Aquí s'utilitza live-manual com a exemple, per tant, cal substituir-lo pel nom del repositori amb que es desitja treballar. Per a obtenir informació detallada sobre com editar live-manual veure Contribuir a aquest document.

●  Obtenir la clau pública:

 $ mkdir -p ~/.ssh/keys
 $ wget http://live-systems.org/other/keys/git@live-systems.org -O ~/.ssh/keys/git@live-systems.org
 $ wget http://live-systems.org/other/keys/git@live-systems.org.pub -O ~/.ssh/keys/git@live-systems.org.pub
 $ chmod 0600 ~/.ssh/keys/git@live-systems.org*  

●  Afegir la següent secció a la configuració del vostre openssh-client:

 $ cat >> ~/.ssh/config << EOF
 Host live-systems.org
     Hostname live-systems.org
     User git
     IdentitiesOnly yes
     IdentityFile ~/.ssh/keys/git@live-systems.org
 EOF  

●  Fer una còpia del manual a través de ssh:

 $ git clone git@live-systems.org:/live-manual.git
 $ cd live-manual && git checkout debian-next  

●  Assegurar-se de tenir el autor i el correu electrònic configurats al Git:

  $ git config user.name "John Doe"
  $ git config user.email john@example.org  

Important: Tenir en compte que s'han d'enviar els canvis a la branca debian-next.

●  Fer els canvis. En aquest exemple s'hauria d'escriure primer una nova secció sobre aplicar pegats i després preparar-se per a afegir els fitxers i escriure el missatge de la següent manera:

 $ git commit -a -m "Adding a section on applying patches."  

●  Fer un push al servidor:

 $ git push