Skip to main content

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, diretrizes de contribuição e um código de conduta, 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 obter mais informações, 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 obter mais informações, 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 obter mais informações, confira "Sobre armazenamento de arquivo grande do Git".