Esta versión de GitHub Enterprise Server se discontinuó el 2024-12-19. No se realizarán lanzamientos de patch, ni siquiera para problemas de seguridad críticos. Para obtener rendimiento mejorado, seguridad mejorada y nuevas características, actualice a la versión más reciente de GitHub Enterprise Server. Para obtener ayuda con la actualización, póngase en contacto con el soporte técnico de GitHub Enterprise.

Procedimientos recomendados para repositorios

Obtén información sobre cómo usar repositorios de forma eficaz y segura.

En este artículo

Creación de una archivo LÉAME

Para facilitar que los usuarios comprendan el trabajo y naveguen por él, se recomienda crear un archivo LÉAME para cada repositorio.

Puedes agregar un archivo README a un repositorio para comunicar información importante sobre tu proyecto. Un archivo LÉAME, junto con una licencia de repositorio, un archivo de cita e instrucciones de contribución, comunica las expectativas de tu proyecto y te ayuda a administrar las contribuciones. Para más información, consulta Acerca de los archivos README.

Protección del repositorio

Debes mantener seguro el repositorio con las características de seguridad disponibles de GitHub para proteger el código frente a vulnerabilidades, el acceso no autorizado y otras posibles amenazas de seguridad. Como mínimo, debes habilitar las siguientes características:

  • Dependabot alerts te notifica sobre las vulnerabilidades de seguridad en la red de dependencias del proyecto para que puedas actualizar la dependencia afectada a una versión más segura.
  • Secret scanning examina el repositorio en busca de secretos (como claves de API y tokens) y te avisa si se encuentra un secreto para que puedas quitarlo del repositorio.
  • La protección contra el envío de cambios impide que tú (y tus colaboradores) introduzcáis secretos en el repositorio en primer lugar, para lo cual bloquea los envíos de cambios que contienen secretos admitidos.
  • Code scanning identifica vulnerabilidades y errores en el código del repositorio para que puedas corregir estos problemas antes y evitar que los actores malintencionados aprovechen una vulnerabilidad o un error.

Además, también puedes tener en cuenta lo siguiente:

  • Agregar un archivo SECURITY.md a un repositorio. El archivo SECURITY.md proporciona instrucciones a los colaboradores sobre cómo notificar vulnerabilidades de seguridad encontradas en el proyecto y fomenta la divulgación responsable.

Para más información, consulta Inicio rápido para proteger el repositorio.

Favorecer la ramificación por encima de la bifurcación

Para simplificar la colaboración, se recomienda que los colaboradores habituales trabajen desde un único repositorio, creando solicitudes de incorporación de cambios entre ramas en lugar de entre repositorios. La bifurcación es más adecuada para aceptar contribuciones de personas que no están afiliadas a un proyecto, como colaboradores de código abierto.

Para mantener la calidad de las ramas importantes, como main, mientras se usa un flujo de trabajo de ramificación, puedes usar ramas protegidas con comprobaciones de estado necesarias y revisiones de solicitudes de incorporación de cambios. Para más información, consulta Acerca de las ramas protegidas.

Use Almacenamiento de archivos de gran tamaño de Git

Para optimizar el rendimiento, GitHub limita los tamaños de los archivos permitidos en los repositorios. Para más información, consulta Acerca de los archivos grandes en GitHub.

Para realizar un seguimiento de archivos grandes en un repositorio de Git, se recomienda usar Almacenamiento de archivos de gran tamaño de Git (Git LFS). Para más información, consulta Acerca de Large File Storage de Git.