Nombres de repositorios de Git

Abdul Jabbar 20 junio 2023
  1. Reglas para nombrar repositorios en Git
  2. Ejemplo de un nombre de repositorio de Git
  3. Conclusión
Nombres de repositorios de Git

En nuestra vida cotidiana, llamar a alguien por su nombre en el momento de la interacción es significativo. Después de todo, su nombre está vinculado de manera más importante a su identidad, que es la forma más sencilla de llamar la atención de alguien.

Y sobre todo, el nombre debe ser conciso para que otras personas no tengan ningún problema en llamarlo o usarlo.

Lo mismo es el caso en Git. La denominación de los repositorios de Git debe ser consistente y compatible para que los usuarios de su cuenta de Git puedan acceder al repositorio requerido fácilmente, sin problemas, haciendo que su trabajo sea más auténtico y profesional usando esos nombres.

Como dijo alguien para los repositorios de Git: “Los grandes nombres de repositorios son cortos y fáciles de recordar”.

Reglas para nombrar repositorios en Git

Elegir un nombre de repositorio conciso y actualizado es una gran tarea al usar Git. Se deben seguir dos reglas al nombrar un repositorio en Git.

  1. El nombre del repositorio debe ser único según su cuenta.

    Eso significa que el nombre de su repositorio debe ser diferente al de su compañero de equipo. Por ejemplo, si el nombre de su repositorio es “mi-mejor-repositorio”, y su compañero de equipo también tenía un repositorio llamado “mi-mejor-repositorio”.

    No es posible porque tener dos repositorios con el mismo nombre en una cuenta es imposible mientras se usa Git.

    Eso significa que otra persona puede tener un repositorio en GitHub llamado my-awesome-repo, y tú también puedes tener uno. Sin embargo, no puede tener dos repositorios con el mismo nombre en su cuenta.

  1. Elija un nombre conciso y compatible que refleje su proyecto.

    Las personas nombran sus repositorios según sus preferencias; algunos prefieren guiones - para separar palabras, mientras que otros usan guiones bajos _.

    Todo esto depende de la preferencia personal de cada uno, cualquier carácter, excepto el espacio y la pestaña, podría hacer la separación. También se deben seguir las conversiones de nombres de acuerdo con las preferencias y reglas del equipo.

Ejemplo de un nombre de repositorio de Git

Siguiendo las sugerencias anteriores, veremos cómo debería ser nuestro repositorio. Dividiremos nuestro nombre de repositorio en tres secciones separadas por guiones.

section1-section2-section3
  1. La sección 1 define el nombre del proyecto en el que trabajamos en equipo.
  2. La Sección 2 define el propósito del proyecto y la definición del proyecto.
  3. La Sección 3 define el lenguaje o marco del proyecto.

Esto podría tener el siguiente aspecto.

Air-SoapAPI-CSharp

Las secciones mencionadas anteriormente se pueden separar aún más mediante guiones si queremos dividirlas, por ejemplo, si separamos la sección 2 del ejemplo anterior, Soap-API.

Conclusión

En este artículo, hemos resumido los criterios para un nombre de repositorio en Git, que incluyen:

  1. Descriptivo
  2. Consistente
  3. Breve (breve/conciso)
  4. Amigable con el futuro
  5. Extensible
  6. Reutilizable
  7. Contextuales
  8. Legible
Abdul Jabbar avatar Abdul Jabbar avatar

Abdul is a software engineer with an architect background and a passion for full-stack web development with eight years of professional experience in analysis, design, development, implementation, performance tuning, and implementation of business applications.

LinkedIn

Artículo relacionado - Git Repository