Lesson 8¶
Lesson 8: Reviewing a Project on GitHub
Table of Contents
Getting an overview of a project on GitHub using the README¶
Veamos la forma recomendada de ver un repositorio en GitHub. Por ejemplo el repositorio de Ruby on Rails.
Si fuese un proyecto que nunca hemos visto antes, primero deberíamos leer el archivo README.md. Aquí encontraremos información general del proyecto.
En la descripción podemos usar medallas (badges) en el archivo README.md. Por ejemplo en código markdown:
[](https://buildkite.com/rails/rails)
Getting more information about a project¶
Luego de leer el archivo README deberíamos mirar los commits recientes. No veremos el último trabajo que las personas han hecho sino el último trabajo que se le ha hecho merge hacia el branch master, que presuntamente ya debe estar listo para producción.
Ver los commits:
GitHub - Commits
Si queremos obtener actividades aún más recientes, no solo los features que han sigo añadidos con merge, debemos ver los pull request:
GitHub - Pull requests
Estas son las unidades de trabajo que se están trabajando, siendo arreglos de bugs o nuevos features.
Introducing issues¶
Otro lugar que vale la pena ver es “Issues”. Es usado para dos casos distintos:
- Track de bugs
- Administrar feature requests
Viewing project state through pulse and graphs¶
Otra área recomendable de mirar para obtener un sentido del proyecto es “Pulse” y “Graphs”:
Podemos ver quienes han contribuido al proyecto y quienes lo han hecho más:
GitHub - Gráfico de contribuidores
Las gráficas de commits mostrará la cantidad de commits por semana a lo largo del tiempo de vida del proyecto en forma de barras:
GitHub - Gráficas de commits
La gráfica de code frequency nos mostrará el número de líneas añadidas y eliminadas del código:
GitHub - Gráficas de Code frequency
Si Graph nos muestra qué pasa a lo largo de la historia de nuestro proyecto, Pulse nos dice qué ha pasado recientemente en el proyecto (el último día, semana, mes):
GitHub - Pulse
Estos números no nos dicen cúantos pull request o issues están abiertos, nos dice cuántos han sido cambiados: