Acerca de los propietarios del código
Puedes usar un archivo CODEOWNERS para definir individuos o equipos que sean responsables del código en un repositorio.
Las personas con permisos administrativos o de propietario pueden configurar un archivo CODEOWNERS en un repositorio.
Las personas que elijas como propietarios del código deben tener permisos de escritura para el repositorio. When the code owner is a team, that team must have write permissions, even if all the individual members of the team already have write permissions directly, through organization membership, or through another team membership.
A los propietarios del código se les solicita revisión de inmediato cuando alguien abre una solicitud de extracción que modifica el código que poseen. A los propietarios del código
Cuando alguien con permisos administrativos o de propietario ha activado las revisiones requeridas, opcionalmente, también pueden solicitar aprobación de un propietario del código antes de que el autor pueda fusionar una solicitud de extracción en el repositorio. Para obtener más información, consulta "Activar revisiones requeridas para solicitudes de extracción".
Ubicación del archivo CODEOWNERS
Para usar un archivo CODEOWNERS, crea un archivo nuevo llamado CODEOWNERS
en la raíz, docs/
, o en el directorio .github/
del repositorio, en la rama en la que quieras agregar los propietarios del código.
Cada archivo CODEOWNERS asigna los propietarios del código para una única rama en el repositorio. De este modo, puedes asignar diferentes propietarios del código para diferentes ramas, como @octo-org/codeowners-team
para una base de código en la rama master
y @octocat
para un sitio Páginas de GitHub en la rama gh-pages
.
Para que los propietarios del código reciban las solicitudes de revisión, el archivo CODEOWNERS debe estar en la rama base de la solicitud de extracción. For example, if you assign @octocat
as the code owner for .js files on the gh-pages
branch of your repository, @octocat
will receive review requests when a pull request with changes to .js files is opened between the head branch and gh-pages
.
Sintáxis de CODEOWNERS
Un archivo CODEOWNERS usa un patrón que sigue las mismas reglas usadas en los archivos gitignore. El patrón es seguido por uno o más nombres de usuarios o nombres de equipos de GitHub usando el formato estándar @username
o @org/team-name
. También puedes hacer referencia a un usuario mediante una dirección de correo electrónico que haya sido agregada a su cuenta de GitHub Enterprise, por ejemplo user@example.com
.
Ejemplo de un archivo CODEOWNERS
# Este es un comentario.
# Cada línea es el patrón de un archivo seguido por uno o más propietarios.
# Estos propietarios serán los propietarios predeterminados para todo en # el repositorio. A menos que una coincidencia posterior tenga prioridad, se le solicitará # revisión a # @global-owner1 y @global-owner2 cuando alguien abra una solicitud de extracción.
* @global-owner1 @global-owner2
# El orden es importante; el último patrón en coincidir tiene la mayor
# prioridad. Cuando alguien abre una solicitud de extracción que solo
# modifica archivos JS, solo se le solicitará una revisión a @js-owner y no al/los # propietario(s) general(es).
*.js @js-owner
# Si prefieres, también puedes usar direcciones de correo electrónico. Serán
# usadas para buscar usuarios como hacemos para los
# correos electrónicos del autor de la confirmación.
*.go docs@example.com
# En este ejemplo, @doctocat posee cualquier archivo en el
# directorio build/logs en la raíz del repositorio y cualquiera de sus
# subdirectorios.
/build/logs/ @doctocat
# El patrón `docs/*` coincidirá con archivos como
# `docs/getting-started.md` pero no con otros archivos anidados como
# `docs/build-app/troubleshooting.md`.
docs/* docs@example.com
# En este ejemplo, @octocat posee cualquier archivo en el directorio de las apps
# en cualquier lugar en tu repositorio.
apps/ @octocat
# En este ejemplo, @doctocat posee cualquier archivo en el
# directorio `/docs` en la raíz de tu repositorio.
/docs/ @doctocat