Diferencia entre revisiones de «Realizando mi primer commit»

De Wiki de EGC
Saltar a: navegación, buscar
(Página creada con «Una vez añades tu primer fichero al repositorio: <source lang="bash"> % git add holamundo.py </source> Tienes que hacer: <source lang="bash"> % git commit -a </source> ...»)
 
 
Línea 12: Línea 12:
  
 
Recuerda que git realiza el commit en local. Por tanto, no aparecerá en el repositorio hasta que realices la orden 'push'.
 
Recuerda que git realiza el commit en local. Por tanto, no aparecerá en el repositorio hasta que realices la orden 'push'.
 +
 +
= Formato del mensaje de commit =
 +
 +
git interprete que la primera línea del mensaje de commit es el título del cambio, seguido de una línea en blanco, tras esto la descripción.
 +
 +
<source lang="bash">
 +
Título
 +
 +
Descripción ...
 +
</source>
 +
 +
No obstante, ''git commit'' no protesta si no usas este formato, pero es deseable que lo sigas pues muchas herramientas de visualización que se integran con git asumen este formato (redmine, github, etc).
 +
 +
Para realizar un buen uso de la herramienta, es deseable que:
 +
 +
* Los títulos no tengan más de 80-100 caracteres de longitud.
 +
* Añade contexto al título, por ejemplo: "Autenticación: Resolver bug en método http_validate()". En este caso, la etiqueta "Autenticación:" indica a que subsistema del proyecto aplica este cambio, la parte que se encuentra a la derecha ofrece el título del cambio referido a dicho contexto.
 +
* Asegúrate de que los cambios aplicados responden a los típicos: ¿qué? ¿por qué? ¿dónde? ¿cuándo? Te serán muy útiles a la hora de hacer arqueología del software.
 +
 +
Intenta elegir un buen título pues es lo que git ofrece como listado a través de ''git log --oneline''.

Revisión actual del 21:45 5 nov 2014

Una vez añades tu primer fichero al repositorio:

% git add holamundo.py

Tienes que hacer:

% git commit -a

Recuerda que git realiza el commit en local. Por tanto, no aparecerá en el repositorio hasta que realices la orden 'push'.

Formato del mensaje de commit

git interprete que la primera línea del mensaje de commit es el título del cambio, seguido de una línea en blanco, tras esto la descripción.

Título

Descripción ...

No obstante, git commit no protesta si no usas este formato, pero es deseable que lo sigas pues muchas herramientas de visualización que se integran con git asumen este formato (redmine, github, etc).

Para realizar un buen uso de la herramienta, es deseable que:

  • Los títulos no tengan más de 80-100 caracteres de longitud.
  • Añade contexto al título, por ejemplo: "Autenticación: Resolver bug en método http_validate()". En este caso, la etiqueta "Autenticación:" indica a que subsistema del proyecto aplica este cambio, la parte que se encuentra a la derecha ofrece el título del cambio referido a dicho contexto.
  • Asegúrate de que los cambios aplicados responden a los típicos: ¿qué? ¿por qué? ¿dónde? ¿cuándo? Te serán muy útiles a la hora de hacer arqueología del software.

Intenta elegir un buen título pues es lo que git ofrece como listado a través de git log --oneline.