Differences

This shows you the differences between two versions of the page.

--- apuntes:git [2021/02/21 17:12] – [Instalación de git] Santiago Faci
+++ apuntes:git [2021/03/04 15:11] (current) – Santiago Faci
@@ Line 3: / Line 3: @@
 {{ git-github.png?400 }}
-===== Introducción a los sistemas de control de versiones =====
-Con el objetivo de que durante el curso podáis trabajar con la herramienta //git// utilizando //Bitbucket// como la plataforma para gestionar vuestros repositorios de código, os dejo aqui una serie de instrucciones muy básicas para comenzar a trabajar y realizar al menos las operaciones más esenciales.
+===== Git y GitHub =====
 ==== Instalación de git ====
@@ Line 24: / Line 24: @@
 <code bash>
 santi@zenbook:$ git config --global user.name "Santiago Faci"
-santi@zenbook:$ git config --global user.email "miemail@codeandcoke.com"
+santi@zenbook:$ git config --global user.email "santi@codeandcoke.com"
 </code>
@@ Line 36: / Line 36: @@
 . . .
 </code>
+==== ¿Qué es GitHub? ====
+[[http://www.github.com|GitHub]] es una plataforma de alojamiento para sistemas de control de versiones basados en [[http://www.git-scm.com|Git]]. Proporciona alojamiento para repositorios de código fuente accesibles mediante el Sistema de Control de Versiones //Git// y además amplía el servicio con sus propias funcionalidades, como son //Gestión de incidencias//, //Wiki//, //Comunidad de usuarios// y otros servicios añadidos a lo que es la gestión del código y el proyecto.
+Actualmente es la plataforma de alojamiento de código fuente más utilizada (alrededor de 20 millones de usuarios la utilizan) y es especialmente conocida en la comunidad de software libre puesto que un gran número de proyectos de licencias alrededor de este tipo de software se alojan en esta plataforma.
+Actualmente //GitHub// ofrece alojamiento y funcionalidades gratuitas para repositorios públicos (orientados al uso de proyectos de software libre) pero paganado es posible conseguir repositorios privados.
 ==== Crear una cuenta en GitHub ====
@@ Line 137: / Line 145: @@
 {{ youtube>jp2xun4IQXU }}
 \\
+==== El fichero README ====
+Es un fichero, que podemos escribir en síntaxis //Markdown//, donde podemos realizar una breve descripción de nuestro proyecto y que GitHub se encargará de renderizar en la portada de la web de nuestro repositorio. Así, es bastante habitual incluir las siguientes secciones:
+  * Título del proyecto
+  * Descripción del proyecto
+  * Requisitos para la instalación
+  * Guía rápida de instalación (y si hay más documentación se enlaza aqui, por ejemplo a la Wiki del proyecto)
+  * Enlace a la web (si la hay)
+  * Información sobre los autores del proyecto
+Hay que tener en cuenta la importancia de este fichero ya que es la primera descripción que un usuario encontrará cuando acceda a nuestro repositorio
+==== El gestor de incidencias ====
+El gestor de incidencias (//issues//) de GitHub permite registrar cualquier tipo de incidencia (//bug, enhancement, proposa o task//) en la plataforma para que pueda ser gestionada y tratada por el equipo de desarrollo. Las incidencias deberán ser asignadas a un usuario que será el encargado de resolverla. Conviene tener en cuenta que hay que marcarlo en el momento de crear el repositorio si queremos poder utilizarlo.
+Lo más importante a la hora de registrar una incidencia es asignarle un título y descripción para que sea fácil de encontrar y reproducir por quién tenga que resolverla (incluso aunque sea uno mismo, no siempre se pueden resolver las incidencias en el momento de encontrarlas y más tarde quizás olvidemos algún detalle). Menos importante pero interesante será definir la inmportancia de la //issue// (ayudará a priorizar) y el tipo de incidencia:
+  * **bug**: Un fallo que se ha localizado en el código
+  * **enhancement**: Una mejora sobre el código ya escrito
+  * **proposal**: Una propuesta sobre el código que ya funciona
+  * **task**: Una tarea que debe realizarse. No tiene porque ir asociada a ningún problema o bug de código
+También podemos adjuntar algún fichero, como por ejemplo capturas que ayuden a detectar o comprender mejor el problema.
+Por último, la incidencia puede ser directamente asignada a un usuario (incluso a uno mismo). En caso de que no se sepa quién debe realizarla se puede dejar en blanco esperando que el responsable decida quién la tiene que corregir.
+La vista de incidencias tiene filtros automáticos que permiten localizar las incidencias rapidamente por su estado.
+Además, el gestor de incidencias de GitHub permite realizar ciertas gestiones sobre las mismas utilizando una serie de comandos que directamente pueden ser aplicados cuando se realizan los //commit// sobre el código con el comando //git//. Una lista de los comandos y opciones disponibles se puede encontrar [[https://docs.github.com/es/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue|aqui]].
+Por ejemplo, si tenemos una incidencia abierta con el número #13 que hace referencia a un //bug// en cierta parte del código, cuando resolvamos el error y nos dispongamos a hacer el //commit// que soluciona dicho problema, podemos ejecutar ese comando de la siguiente forma:
+<code bash>
+santi@zenbook:$ git commit -m 'Corregido el fallo que impedía conectar con la Base de Datos fix #13'
+</code>
+De esta forma, la incidencia con el número #13 será automáticamente marcada como resuelta sin que tengamos que acceder con el navegador al gestor de incidencias y resolverla manualmente a través de la web. Además, el mensaje del //commit// quedará asociado como mensaje de resolución de dicha incidencia.
+==== La Wiki ====
+Siempe que creemos por primera vez un repositorio en GitHub tendremos la oportunidad de decidir si queremos que se integre una Wiki con él.
+A través de la Wiki podremos crear documentación asociada a nuestro proyecto/repositorio utilizando como síntaxis //Markdown// para su edición. En la página de GitHub puedes encontrar una [[https://docs.github.com/en/github/building-a-strong-community/about-wikis|Guía para la Wiki de GitHub]] que puedes usar con la plataforma para saber cómo trabajar con la Wiki y para conocer la sintaxis que debes usar para editarla.
 ----
@@ Line 161: / Line 214: @@
 <caption>Features</caption>
 </figure>
+{{ youtube>IXoLrLXTkR8 }}
+\\
 Cuando llega el momento de liberar una nueva versión, se crea una nueva rama con el objetivo de comenzar el ciclo de liberación. Ya no es posible incorporar nuevas funcionalidades a esta nueva rama (nueva //release//) sino que solamente se corrigen fallos y cualquier otra tarea relacionada con la liberación de la nueva versión. Finalmente, cuando está lista, se fusiona con la rama principal (//master//).
 <figure>
-{{ git-flow.png }}
+{{ releases.png }}
 <caption>Releases</caption>
 </figure>
@@ Line 383: / Line 439: @@
 Your branch is up-to-date with 'origin/master'.
 </code>
+----
+===== Ejercicios =====
+{{ ejercicio.png}}
+  - Crea un repositorio en [[http://www.github.com|GitHub]] llamado //nombreapellidos// para almacenar el código de un proyecto en Java.
+    - Añade un fichero ''README.md'' al repositorio con el título del proyecto, una descripción del mismo y la información del autor
+    - Añade un fichero con la licencia del proyecto
+    - Añade un fichero ''.gitignore'' para ignorar los ficheros compilados del proyecto y de configuración (''.conf'')
+    - Descarga el repositorio en tu equipo y comienza a trabajar
+    - Cuando tengas la primera funcionalidad terminada sube el código al repositorio y validalo
+  - Sobre el repositorio anterior, imagina ahora que empiezas a trabajar en dicho proyecto y eres el encargado de añadir una nueva funcionalidad (un nuevo método, por ejemplo):
+    - Descargate el repositorio con la idea de seguir trabajando en él
+    - Añade la funcionalidad requerida
+    - Modifica el ''README.md'' para añadir tu nombre como colaborador del mismo
+    - Comprueba el estado del repositorio en tu equipo (''status'')
+    - Añade los cambios realizados al proyecto
+  - Sobre el mismo repositorio que los puntos anteriores, imagina que debes de eliminar un fichero que ya no es necesario que forme parte del mismo (si hace falta añade alguno para luego eliminarlo) y tampoco quieres que siga en tu equipo
+  - Imagina ahora que debes de eliminar un fichero que ya no es necesario que forme parte del mismo (si hace falta añade alguno para luego eliminarlo) pero quieres que siga formando parte del repositorio local en tu equipo
+  - Añade ahora en la ''Wiki'' del proyecto información sobre como instalar, ejecutar y usar la aplicación (3 páginas diferentes enlazadas y organizadas desde la portada de la Wiki)
+  - Registra ahora una nueva incidencia de tipo //mejora// para el repositorio y programa dicha mejora. En el momento de hacer el commit del código que la añade, haz que se marque como corregida.
+  - Amplia el ''README'' del proyecto y asegurate de que, al menos, incluyes la siguiente información
+    - Descripción breve del proyecto
+    - Requisitos para su instalación/puesta en marcha (remite a la Wiki para más información)
+    - Guía rápida de instalación (remite a la Wiki para más información)
+    - Información sobre los autores
 ----
 (c) 2020-2021 Santiago Faci