Optimización del trabajo con sus proyectos en GitHub: familiarizándose con el repositorio de plantillas de Github

¡Hola a todos, comunidad JavaRush! Hoy hablaremos sobre código abierto y lo que se necesita para crear un proyecto de alta calidad ADEMÁS del código escrito. Es importante escribir un producto útil. Pero no menos importante es el correcto diseño del repositorio (repositorio de proyectos en GitHub). Esto ayudará a implementar otro punto clave: la promoción del producto. Incluso si el proyecto es genial, pero está mal diseñado, no está descrito al menos en el README (puedes leer sobre qué es un README aquí ), no se indica la licencia, etc., etc., habrá sin éxito. Es solo que nadie se fijará en él. Y si alguien se da cuenta, no sabrá cómo interactuar con él. Hay muchas cosas que deben completarse una y otra vez, y no es fácil para el programador copiar y pegar cada vez, y solo por esto, este verano, GitHub lanzó la función Repositorio de plantillas que ayuda con esto. Por así decirlo, automatizar el proceso de creación de nuevos proyectos. Hoy entenderemos qué es un Repositorio y qué es un Repositorio de Plantillas. Describiremos qué debería haber en el proyecto además del código, en qué cosas debes concentrarte. Creemos un Repositorio de Plantillas desde cero y agreguemos todo lo necesario desde mi punto de vista. Y finalmente, usaremos el Repositorio de plantillas al crear un nuevo repositorio. Pero primero, comprendamos los términos. Teoría: qué debería estar en el repositorio general de cualquier proyecto. Todo proyecto de código abierto en GitHub debe tener un Perfil de comunidad bien descrito , que contenga los siguientes elementos.

1. Plantilla de emisión

Aquí es necesario describir las reglas para crear una incidencia en el repositorio: cómo se deben llamar, cuál será la etiqueta y quién se le asignará. Al crear una nueva Issue, se ofrecerán las siguientes opciones:

• Informe de error : creación de un problema para describir un defecto en el proyecto;
• Solicitud de funciones : propuesta de una nueva idea para un proyecto;
• Solicitud de mejora - propuesta de mejora del proyecto;
• Plantilla de problema personalizada : si otras opciones no funcionan, puede utilizar una plantilla vacía.

Se puede ver un ejemplo de cómo se ve esto aquí .

2. Licencia

La licencia bajo la cual está escrito el proyecto. Es necesario para que quienes utilizarán el proyecto sepan qué está garantizado y qué no. Por ejemplo, la Licencia Apache 2.0 dice lo siguiente:

3.README

Esta es una descripción del proyecto, su tarjeta de presentación. Todo lo que hay que decir sobre el proyecto debería estar aquí. Por supuesto, será necesario describirlo cada vez, teniendo en cuenta las particularidades del proyecto, pero los títulos serán los mismos. Por ejemplo:

• Descripción general: una breve descripción del proyecto;
• Uso: cómo utilizar el proyecto;
• Construcción: cómo lanzar un proyecto, qué se necesita para ello;
• Solución de problemas: describe los problemas que puede encontrar y cómo resolverlos;
• Notas de la versión: descripción de los cambios según la versión;
• Autores: no se olviden de sus seres queridos;
• Contribuir: una descripción de cómo puede participar en el desarrollo del proyecto;
• Código de conducta: descripción de las reglas de participación;
• RELEASE_NOTES : un archivo en el que se registran todos los cambios de las nuevas versiones. Es una buena práctica poner esto en un documento separado y almacenar un enlace en el archivo README;
• CONTRIBUTING es una ficha que describe cómo puedes contribuir al desarrollo de este proyecto. Creado como un archivo separado para el encabezado Contributing en el archivo README;
• CODE_OF_CONDUCT : un archivo que describe las reglas para participar en el desarrollo del proyecto;
• Plantilla de solicitud de extracción : una plantilla para quienes crearán una solicitud de extracción.

Todas estas cosas se utilizan de un proyecto a otro, independientemente del lenguaje de programación o sus detalles.

Práctica: crear tu propia plantilla

Como dicen, pasemos de las palabras a la acción. Ahora, usando un ejemplo, te mostraré cómo crear tu propia plantilla.

1. Lo primero que necesitas es una cuenta en GitHub/ regístrate allí .

2. Cree un nuevo repositorio: para hacer esto, haga clic en + en la esquina superior derecha

3. Al crear, complete:

   • Nombre del repositorio: en mi caso, plantilla-repositorio;
   • Descripción: breve descripción del proyecto;
   • Salimos de Público, aunque puedes seleccionar Privado;
   • Marque la casilla de inicialización LÉAME:

   • Seleccione la licencia bajo la cual se realizará el proyecto:

     Como en mi caso la plantilla es general, gitignore no es necesario: se agregará para un proyecto y lenguaje de programación específicos.

     Por lo tanto, haga clic en Crear repositorio , completando así el proceso de creación. El sistema nos llevará automáticamente al repositorio recién creado.

4. Completar el perfil de la comunidad : en el repositorio creado, vaya a la pestaña Insights y seleccione Comunidad :

   Como puede ver, todo lo que queda es completar la plantilla de Código de conducta, Contribución, Plantilla de problema y Solicitud de extracción.

   Usando el ejemplo del Código de conducta, mostraremos cómo agregarlos a un proyecto.

   Haga clic en Agregar , el sistema le solicitará que seleccione Pacto del colaborador o Código de conducta del ciudadano :

   Selecciono el primero y hago clic en Revisar y enviar .

   A continuación, puede editar este archivo y confirmarlo.

   En la parte inferior, seleccione la opción Confirmar directamente en la rama maestra y haga clic en Confirmar nuevo archivo :

   Como resultado, si volvemos al Perfil de la Comunidad , encontraremos que el Código de Conducta está marcado como agregado:

   La plantilla de contribución y de problema se agregan de manera similar, por lo que no mostraré esto. Hazlo tu mismo ;)

5. Agregar plantilla de solicitud de extracción .

   Pero hablemos de esto por separado.

   No sé por qué GitHub no ha agregado la misma opción conveniente para configurar la plantilla Pull-Request, por lo que tendrás que estudiar la documentación y agregarla manualmente.

   Para hacer esto, haga clic en Crear nuevo archivo en la raíz del repositorio :

   El nombre del archivo debe ser: .github/pull_request_template.md .

   Agregamos lo que necesitamos a la plantilla y hacemos clic en Confirmar nuevo archivo , como hicimos anteriormente. No iba a reinventar la rueda y encontré un ejemplo que me pareció bastante utilizable.

   De esta forma se rellenará todo el Perfil de la Comunidad:

6. Agregue un marcador de repositorio de plantillas .

   Para hacer esto, vaya a la opción Configuración en el repositorio y marque la casilla donde dice Repositorio de plantillas:

   Y listo, la plantilla para crear nuevos proyectos está lista. Así, ahorraremos mucho tiempo en el futuro cuando necesitemos crear nuevos proyectos. Esto también te ayudará a no perderte detalles importantes, ya que muchas veces sucede que olvidas agregar algo, por ejemplo una licencia o una plantilla clara para un problema.

Cómo utilizar el repositorio de plantillas

Hay dos opciones de uso:

1. Cuando una plantilla es de su propiedad directamente: al crear un nuevo repositorio, se le dará la opción de crear a partir de una plantilla de la lista de plantillas de su propiedad:

2. Cuando la plantilla es extranjera: aquí tampoco hay problemas especiales. Vaya a esa plantilla y haga clic en el botón Usar esta plantilla . Aquí usaré la animación del documento oficial:

resumámoslo

En este artículo analizamos:

• ¿Qué es el repositorio de GitHub?
• ¿Qué es el repositorio de plantillas?
• qué debería haber en el repositorio de plantillas;
• cómo crear un repositorio de plantillas;
• cómo utilizar el repositorio de plantillas.

Por supuesto, a partir de esta plantilla ya puedes crear otras más específicas. Por ejemplo, creé más plantillas con sistemas de compilación maven o gradle ya configurados. Más aún: puede crear una plantilla de repositorio Spring Boot basada en las dos últimas. Para agrupar todas las plantillas, creé una organización de repositorio de plantillas en GitHub con todas las plantillas. Suscríbete a mi cuenta de GitHub

Enlaces útiles

• Organización con todas las plantillas que creé.
• Blog de GitHub: Generar nuevo repositorio con plantillas de repositorio cómo crear una plantilla para repositorios
• Ayuda de GitHub: Acerca de los repositorios sobre qué son los repositorios.
• Ayuda de GitHub: Crear un repositorio a partir de una plantilla cómo crear un nuevo proyecto basado en una plantilla
• Ayuda de GitHub: Licencia de un repositorio descripción de licencias para proyectos
• Ayuda de GitHub: Crear una descripción de repositorio para crear un repositorio
• Consejos de las guías de código abierto para crear/describir proyectos de código abierto.
• Ayuda de GitHub: agregar una plantilla de solicitud de extracción : crear una plantilla para solicitudes de extracción.

Más de mis artículos

• Depuración en Intellij IDEA: una guía para principiantes
• Guía para crear un cliente para la API de Skyscanner y publicarlo en jCenter y Maven Central [Parte 1]
• Guía para crear un cliente para la API de Skyscanner y publicarlo en jCenter y Maven Central [Parte 2]
• Creación de un sistema de seguimiento de precios de billetes de avión: una guía paso a paso [Parte 1]
• Creación de un sistema de seguimiento de precios de billetes de avión: una guía paso a paso [Parte 2]
• Creación de un sistema de seguimiento de precios de billetes de avión: una guía paso a paso [Parte 3]
• Tala: ¿qué, cómo, dónde y con qué?
• Cómo una prueba de entrevista se convirtió en una biblioteca de código abierto
• Historia de éxito. 20 horas de programación semanales, maestría y vida personal
• como encontrar un trabajo? Consejos para enviar currículums