Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

Sobre proprietários do código

Você pode usar um arquivo CODEOWNERS para definir indivíduos ou equipes que são responsáveis pelo código em um repositório.

Você pode definir proprietários de código em repositórios públicos com GitHub Free e GitHub Free para organizações e em repositórios públicos e privados com GitHub Pro, GitHub Team, GitHub Enterprise Cloud e GitHub Enterprise Server.

Neste artigo

Did this doc help you?

As pessoas com permissões de administrador ou proprietário podem configurar um arquivo CODEOWNERS em um repositório.

As pessoas que você escolhe como proprietários do código devem ter permissões de gravação para o repositório. Quando o proprietário do código for uma equipe, essa equipe deverá ter permissões de gravação, mesmo se todos os membros individuais da equipe já tiverem permissões de gravação diretamente, ou por meio da associação à organização, ou por meio da associação a outra equipe.

Sobre proprietários do código

Solicita-se automaticamente que os proprietários do código revisem quando alguém abre um pull request que modifica o código que possuem. Solicita-se automaticamente que os proprietários do código revejam os rascunhos de pull requests. Para obter mais informações sobre pull requests em rascunho, consulte "Sobre pull requests". Solicita-se automaticamente que os proprietários do código revejam os rascunhos de pull requests. Se você converter um pull request em rascunho, as pessoas que já assinaram as notificações não terão suas assinaturas canceladas automaticamente. Para obter mais informações, consulte "Alterar o stage de um pull request".

Quando alguém com permissões de administrador ou proprietário tiver habilitado revisões obrigatórias, se desejar, ele também poderá exigir aprovação de um proprietário do código para que o autor possa fazer merge de uma pull request no repositório. Para obter mais informações, consulte "Habilitar revisões obrigatórias para pull requests".

Se uma equipe tiver habilitado as tarefas de revisão de código, as aprovações individuais não satisfarão o requisito para a aprovação do proprietário do código em um branch protegido. Para obter mais informações, consulte "Gerenciando a responsabilidade pela revisão de código para sua equipe."

Local do arquivo CODEOWNERS

Para usar um arquivo CODEOWNERS, crie um novo arquivo denominado CODEOWNERS na raiz, docs/ ou no diretório .github/ do repositório, no branch em que deseja adicionar os proprietários do código.

Cada arquivo CODEOWNERS atribui os proprietários do código para um único branch no repositório. Dessa forma, você pode atribuir diferentes proprietários de códigos para diferentes branches, como @octo-org/codeowners-team para uma base de código no branch-padrão e @octocat para um site do GitHub Pages no branch de gh-pages.

Para que os proprietários do código recebam solicitações de revisão, o arquivo CODEOWNERS deve estar no branch base da pull request. Por exemplo, se você atribuir @octocat como o proprietário do código para arquivos .js no branch gh-pages do seu repositório, @octocat receberá solicitações de revisão quando uma pull request com alterações nos arquivos .js for aberta entre o branch head e gh-pages.

Sintaxe de CODEOWNERS

Um arquivo CODEOWNERS usa um padrão que segue as mesmas regras usadas nos arquivos gitignore. O padrão é seguido por um ou mais nomes de usuário ou nomes de equipe do GitHub usando o formato padrão @username ou @org/team-name. Você também pode consultar um usuário por um endereço de e-mail que tenha sido adicionado à respectiva conta do GitHub Enterprise, por exemplo user@example.com.

Se qualquer linha do seu arquivo CODEOWNERS contiver uma sintaxe inválida, o arquivo não será detectado e não será usado para solicitar revisões. A sintaxe inválida inclui comentários embutidos e nomes de usuário ou equipe que não existem em GitHub Enterprise.

Exemplo de um arquivo CODEOWNERS

# Este é um comentário.
# Cada linha é um padrão de arquivo seguido por um ou mais proprietários.

# Esses proprietários serão os proprietários padrão para tudo no
# repositório. A menos que uma correspondência posterior tenha precedência,
# @global-owner1 e @global-owner2 serão solicitados para
# revisão quando alguém abrir uma pull request.
*       @global-owner1 @global-owner2

# A ordem é importante; o último padrão de correspondência tem
# prioridade. Quando alguém abre uma pull request que
# modifica apenas arquivos JS, somente @js-owner, e não o(s)
# proprietário(s) global(is), será solicitado para uma revisão.
*.js    @js-owner

# Você também pode usar endereços de e-mail se preferir. Eles serão
# usados para procurar usuários assim como fazemos com e-mails do
# autor do commit.
*.go docs@example.com

# Neste exemplo, @doctocat tem arquivos no diretório
# build/logs na raiz do repositório e qualquer um de seus
# subdiretórios.
/build/logs/ @doctocat

# O padrão `docs/*` corresponderá a arquivos como
# `docs/getting-started.md`, mas a nenhum outro arquivo aninhado como
# `docs/build-app/troubleshooting.md`.
docs/*  docs@example.com

# Neste exemplo, @octocat tem qualquer arquivo no diretório apps
# em qualquer lugar do seu repositório.
apps/ @octocat

# Neste exemplo, @doctocat tem qualquer arquivo no diretório
# `/docs` na raiz do seu repositório.
/docs/ @doctocat

Leia mais

Did this doc help you?