Contribuir al proyecto

Contribuir al proyecto

Cuando se envía una contribución se debe identificar claramente al titular de los derechos de autor e incluir la declaración de las licencias aplicables. Se hace notar que para ser aceptada, una contribución debe ser publicada bajo la misma licencia que el resto del documento, es decir, GPL versión 3 o posterior.

Las contribuciones al proyecto, tales como traducciones y parches, son muy bienvenidas. Cualquiera puede hacer una entrega en los repositorios, sin embargo, a la hora de hacer grandes cambios, es conveniente enviarlos a la lista de correo para debatirlos primero. Ver la sección Contacto para más información.

El ${project} utiliza Git como sistema de control de versiones y gestión de código fuente. Como se explica en Repositorios Git hay dos ramas principales de desarrollo: debian y debian-next. Todo el mundo puede hacer entregas a las ramas debian-next de los repositorios live-boot, live-build, live-config, live-images, live-manual y live-tools.

Sin embargo, existen ciertas restricciones. El servidor rechazará:

●  Entregas que no sean fast-forward

●  Entregas que hagan fusiones.

●  Añadir o borrar etiquetas o ramas.

A pesar de que todas las entregas pueden ser revisadas, pedimos usar el sentido común y hacer buenos commits con mensajes de commit adecuados.

●  Hay que escribir mensajes de entrega que consistan en una frase en ingles con significado completo, comenzando con una letra mayúscula y acabando con un punto final. Es habitual comenzar estas frases con la forma 'Fixing/Adding/Removing/Correcting/Translating/...'.

●  Escribir buenos mensajes de entrega. La primera frase debe ser un resumen exacto de los contenidos del commit, que se incluirá en la lista de cambios. Si se necesita hacer algunas aclaraciones, escribirlas debajo dejando una línea en blanco después de la primera y luego otra línea en blanco después de cada párrafo. Las líneas de los párrafos no deben superar los 80 caracteres de longitud.

●  Hacer entregas de forma atómica, es decir, no mezclar cosas no relacionadas en el mismo commit. Hacer un commit diferente para cada cambio que se realice.

Realizar cambios

Para hacer una entrega a los repositorios, se debe seguir el siguiente procedimiento. Aquí se utiliza live-manual como ejemplo, por eso hay que sustituirlo por el nombre del repositorio con el que se desea trabajar. Para obtener información detallada sobre cómo editar live-manual ver Contribuir a este documento.

●  Obtener la clave pública de entrega:

 $ 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*  

●  Añadir la siguiente sección en el fichero de configuración de 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  

●  Obtener un clon del manual mediante git utilizando ssh:

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

●  Acordarse de configurar el autor y el email en Git:

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

Importante: Recordar que hay que enviar los cambios a la rama debian-next.

●  Efectuar los cambios. En este ejemplo, primero se escribiría una nueva sección sobre cómo aplicar parches y luego se añadirían los ficheros y se escribiría el mensaje de la siguiente manera:

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

●  Para finalizar se realizará la entrega al servidor:

 $ git push