gitignore

Uma coleção de modelos .gitignore

Esta é a coleção de modelos de arquivo .gitignore do Github. Usamos esta lista para preencher os escolhidos de modelo .gitignore disponíveis na interface github.com ao criar novos repositórios e arquivos.

Para obter mais informações sobre como os arquivos .gitignore funcionam e como usá -los, os seguintes recursos são um ótimo lugar para começar:

• O capítulo Ignoring Arquivos do livro Pro Git.
• O artigo de Ignoration Arquivos no site do GitHub Ajuda.
• A página manual Gitignore (5).

Estrutura de pastas

Apoiamos uma coleção de modelos, organizados dessa maneira:

• A pasta raiz contém modelos de uso comum, para ajudar as pessoas a começar com linguagens e tecnologias de programação populares. Eles definem um conjunto significativo de regras para ajudar a começar e garantem que você não esteja cometendo arquivos sem importância no seu repositório.
• Global contém modelos para vários editores, ferramentas e sistemas operacionais que podem ser usados ​​em diferentes situações. É recomendável que você os adicione ao seu modelo global ou mescla essas regras em seus modelos específicos do projeto, se desejar usá-los permanentemente.
• community contém modelos especializados para outros idiomas, ferramentas e projetos populares, que atualmente não pertencem aos modelos principais. Eles devem ser adicionados aos seus modelos específicos do projeto quando você decidir adotar a estrutura ou ferramenta.

O que faz um bom modelo?

Um modelo deve conter um conjunto de regras para ajudar os repositórios Git a trabalhar com uma linguagem de programação específica, estrutura, ferramenta ou ambiente.

Se não for possível selecionar um pequeno conjunto de regras úteis para essa situação, o modelo não é um bom ajuste para esta coleção.

Se um modelo for principalmente uma lista de arquivos instalados por uma versão específica de algum software (por exemplo, uma estrutura PHP), ele poderá viver no diretório community . Veja modelos de versão para obter mais detalhes.

Se você possui um pequeno conjunto de regras ou deseja apoiar uma tecnologia que não esteja amplamente em uso e ainda acreditar que isso será útil para outras pessoas, leia a seção sobre modelos especializados para obter mais detalhes.

Inclua detalhes ao abrir a solicitação de tração se o modelo for importante e visível. Podemos não aceitá -lo imediatamente, mas podemos promovê -lo à raiz posteriormente com base no interesse.

Por favor, entenda também que não podemos listar todas as ferramentas que já existiram. Nosso objetivo é curar uma coleção dos modelos mais comuns e úteis , não garantir que abordemos todos os projetos possíveis. Se optarmos por não incluir seu idioma, ferramenta ou projeto, não é porque não é incrível.

Diretrizes contribuintes

Adoraríamos que você nos ajudasse a melhorar este projeto. Para nos ajudar a manter esta coleção de alta qualidade, solicitamos que as contribuições aderem às seguintes diretrizes.

• Forneça um link para o aplicativo ou a página inicial do projeto . A menos que seja extremamente popular, há uma chance de os mantenedores não conhecerem ou usarem o idioma, a estrutura, o editor, o aplicativo ou o projeto que sua alteração se aplica.

• Forneça links para a documentação que suporta a mudança que você está fazendo. A documentação canônica atual mencionando que os arquivos que estão sendo ignorados é melhor. Se a documentação não estiver disponível para apoiar sua alteração, faça o melhor possível para explicar para que servem os arquivos que estão sendo ignorados.

• Explique por que você está fazendo uma mudança . Mesmo que pareça evidente, receba uma frase ou duas para nos dizer por que sua mudança ou adição deve acontecer. É especialmente útil articular por que essa mudança se aplica a todos que trabalham com a tecnologia aplicável, em vez de apenas você ou sua equipe.

• Por favor, considere o escopo da sua mudança . Se sua alteração for específica para um determinado idioma ou estrutura, verifique se a alteração é feita no modelo para esse idioma ou estrutura, em vez do modelo para um editor, ferramenta ou sistema operacional.

• Modifique apenas um modelo por solicitação de tração . Isso ajuda a manter solicitações de puxar e feedback focado em um projeto ou tecnologia específica.

Em geral, quanto mais você pode fazer para nos ajudar a entender a mudança que você está fazendo, maior a probabilidade de aceitar sua contribuição rapidamente.

Modelos de versão

Alguns modelos podem mudar bastante entre as versões e, se você deseja contribuir com este repositório, precisamos seguir esse fluxo específico:

• O modelo na raiz deve ser a versão atual suportada
• O modelo na raiz não deve ter uma versão no nome do arquivo (ou seja, "Evergreen")
• As versões anteriores dos modelos devem viver sob community/
• As versões anteriores do modelo devem incorporar a versão no nome do arquivo, para legibilidade

Isso ajuda a garantir que os usuários obtenham a versão mais recente (porque eles usarão o que estiver na raiz), mas ajuda os mantenedores a suportar versões mais antigas ainda na natureza.

Modelos especializados

Se você tiver um modelo que gostaria de contribuir, mas não é o mainstream, considere adicioná -lo ao diretório community sob uma pasta que melhor se adequa onde ela pertence.

As regras em seu modelo especializado devem ser específicas para a estrutura ou ferramenta, e quaisquer modelos adicionais devem ser mencionados em um comentário no cabeçalho do modelo.

Por exemplo, este modelo pode morar em community/DotNet/InforCRM.gitignore :

 # gitignore template for InforCRM (formerly SalesLogix)
# website: https://www.infor.com/product-summary/cx/infor-crm/
#
# Recommended: VisualStudio.gitignore

# Ignore model files that are auto-generated
ModelIndex.xml
ExportedFiles.xml

# Ignore deployment files
[Mm]odel/[Dd]eployment

# Force include portal SupportFiles
!Model/Portal/*/SupportFiles/[Bb]in/
!Model/Portal/PortalTemplates/*/SupportFiles/[Bb]in

Fluxo de trabalho contribuindo

Veja como sugerimos que você proponha uma mudança para este projeto:

1. Bifurque este projeto para sua conta.
2. Crie uma filial para a mudança que você pretende fazer.
3. Faça suas alterações no garfo.
4. Envie uma solicitação de tração da filial do seu garfo para nossa filial main .

O uso da interface baseado na Web para fazer alterações também é bom e ajudará você a forçar automaticamente o projeto e solicitando enviar uma solicitação de tração também.

Licença

CC0-1.0.