Source code management/es

Nuestra principal herramienta de gestión del código fuente es Git. Este artículo explica como utilizarlo y las reglas generales aplicadas en el caso de FreeCAD.

Via github.com
Una forma sencilla de empezar con el código de FreeCAD es utilizar github.com. Aquí nuestra rama principal está reflejada y se puede clonar de forma sencilla

y utilizar

https://github.com/FreeCAD

es también un sistema simple de ofrecer código para su revisión y peticiones de fusión.

Via sf.net
Para acceder a un repositorio de Git en sf.net, configura tu cliente de Git como se indica a continuación:

git://free-cad.git.sourceforge.net/gitroot/free-cad/free-cad (sólo lectura) ssh://USERNAME@free-cad.git.sourceforge.net/gitroot/free-cad/free-cad (lectura/escritura)

Reglas de acceso
Le daremos a todos los interesados en participar acceso de escritura al repositorio de Git siempre que se mantengan alejados de la rama principal (consejo).

Autentificación
El acceso de sólo lectura no pregunta por una contraseña.

El acceso de lectura/escritura utiliza tu contraseña de ssh o clave de ssh para autorizar tu acceso. Para realizar operaciones de escritura, tu administrador del proyecto debe garantizar que tienes acceso de escritura al repositorio.

Nota: - En todos los ejemplos de abajo, "USERNAME" representa el nombre de usuario de tu cuenta de SourceForge.net.

Cómo clonar un repositorio
Puedes simplemente clonar tu repositorio remoto y ponerte a trabajar:

git clone ssh://USERNAME@free-cad.git.sourceforge.net/gitroot/free-cad/free-cad REPONAME cd REPONAME

La primera vez que intentes conectar al host free-cad.git.sourceforge.net, deberías ver un mensaje similar al siguiente:

The authenticity of host 'free-cad.git.sourceforge.net (216.34.181.91)' can't be established. RSA key fingerprint is 86:7b:1b:12:85:35:8a:b7:98:b6:d2:97:5e:96:58:1d. Are you sure you want to continue connecting (yes/no)?

Antes de contestar 'yes' para aceptar la huella del host, asegúrate de que la huella es correcta para el host. Puedes encontrar una lista de claves de host SSH en la lista de huellas de claves de host SSH. Si recibes una advertencia de clave del host, por favor contacta con el equipo de SourceForge.net.

Configurando tu nombre de usuario en Git
Los usuarios deberían enviar a sus repositorios de proyecto utilizando sus nombres de usuario de SourceForge.net. Si no está definido globalmente, lo puedes definir localmente para el repositorio de Gir actual así:

git config user.name "YOUR NAME" git config user.email "USERNAME@users.sourceforge.net"

Ahora puedes utilizar alguna combinación de los comandos "git add" y "git commit" para crear uno o más envíos en tu repositorio local.

En desarrollo
Antes de nada nunca desarrolles en el ramal principal'''! Crea un ramal local para el desarrollo. Puedes aprender a hacer esto aquí.

Ramificado
Una importante característica de Git es que es extremadamente sencillo trabajar con ramas y fusionarlas. La mejor forma de trabajar recomienda crear una nueva rama siempre que quieras trabajar en una nueva característica. La creación de una rama se hace con:

git branch myNewBranch git checkout myNewBranch

o, ambas operaciones en una:

git checkout -b myNewBranch

siempre puedes comprobar con que rama estas:

git branch

Envío
Una vez que hagas algo de trabajo, envíalo con:

git commit -a

A diferencia de SVN, tienes que especificar los archivos que quieres enviar (o todos con la opción -a). Tu editor de texto se abrirá para permitirte escribir un mensaje de envío.

Publicación de tu trabajo en el repositorio de sourceforge
Después de hacer algunos cambios en tu ramal local y enviarlos (es decir, enviarlos "localmente") puedes enviar tu repositorio al servidor. Esto abre tu ramal al público y permite que los desarrolladores principales revisen e integren tu ramal en el principal.

git push my-branch

Publicación en otro repositorio
Git también te permite fusionar ramas de más de un repositorio. Si no tienes acceso de escritura al repositorio de Git de FreeCAD que ofrece sourceforge, también puedes definir una cuenta o cualquier huésped gratuito de Git como github o gitorious y decirle a otras personas que puedes obtener tus cambios de allí.

Escribiendo buenos mensajes de envío
Deberías tratar de trabajar en pedazos pequeños. Si no puedes resumir tus cambios en una frase, entonces posiblemente ha pasado pasado demasiado tiempo desde que hiciste un envío. También es importante que ofrezcas descripciones de tu trabajo que sean útiles y ayuden. Para los mensajes de envío, FreeCAD ha adoptado un formato mencionado en el libro Pro Git (mira ).

Resumen corto (50 caracteres o menos) de cambios

Texto de explicación más detallado, si es necesario. En unos 72 caracteres. En algunos contextos, la primera línea es tratada como el tema de un email y el resto del texto como el cuerpo. La línea en blanco separando el tema del cuerpo es crítica (a menos que omitas el cuerpo por completo); las herramientas de recálculo se pueden confundir si pones los dos juntos. Más párrafos van después de líneas en blanco. - Las listas con viñetas también están bien - Tipicamente un guión o asterisco se utiliza para la viñeta, precedido por un espacio en blanco, con líneas en blanco en medio, pero las convenciones aquí varían

Si estas haciendo un montón de trabajo relacionado, se sugiere aquí que deberías hacer tantos envíos grandes o pequeños como sea necesario para que tengan sentido en lo que estés trabajando utilizado los mensajes cortos de envío. Cuando quieras fusionarlos, haz un registro master..BRANCH y utiliza el resultado para tu mensaje de envío. Cuando fusionas con el principal utiliza la opción --squash y envía con tu mensaje de envío. Esto te permitirá ser muy liberal con tus envíos y ayudar a proporcionar un buen nivel de detalle en los mensajes de envío sin demasiadas descripciones distintas.

Otras lecturas

 * Git para los perezosos
 * Git pro libro on-line