Skip to main content

Esta versão do GitHub Enterprise Server foi descontinuada em 2024-09-25. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise Server. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.

Práticas recomendadas para repositórios

Saiba como usar os repositórios de maneira mais eficaz.

Criar um arquivo LEIAME

Para que as pessoas possam entender e navegar mais facilmente por seu trabalho, crie um arquivo LEIAME para cada repositório.

É possível adicionar um arquivo README a um repositório para comunicar informações importantes sobre o seu projeto. Um LEIAME, junto com uma licença de repositório, um arquivo de citação e diretrizes de contribuição, comunica as expectativas do projeto e ajuda você a gerenciar contribuições. Para saber mais, confira Sobre LEIAMEs.

Preferir branches a forks

Para simplificar a colaboração, recomenda-se que os colaboradores regulares trabalhem em um único repositório, criando solicitações de pull entre branches em vez de entre repositórios. O uso de fork é mais adequado para aceitar contribuições de pessoas não afiliadas a um projeto, como colaboradores de código aberto.

Para manter a qualidade de branches importantes, como main, ao usar um fluxo de trabalho de branch, é possível usar branches protegidos com verificações de status obrigatórias e revisões de solicitação de pull. Para saber mais, confira Sobre branches protegidos.

Usar o Git Large File Storage

Para otimizar o desempenho, o GitHub limita os tamanhos de arquivo permitidos nos repositórios. Para saber mais, confira Sobre arquivos grandes no GitHub.

Para rastrear arquivos grandes em um repositório Git, recomenda-se usar o Git Large File Storage (Git LFS). Para saber mais, confira Sobre armazenamento de arquivo grande do Git.