gitignore README

The project's README from github.com/github/gitignore. As one markdown file: README.md.

A collection of .gitignore templates

This is GitHub’s collection of .gitignore file templates. We use this list to populate the .gitignore template choosers available in the GitHub.com interface when creating new repositories and files.

For more information about how .gitignore files work, and how to use them, the following resources are a great place to start:

Folder structure

We support a collection of templates, organized in this way:

What makes a good template?

First and foremost, a template contribution must adhere to our Contributing Guidelines.

A template should contain a set of rules to help Git repositories work with a specific programming language, framework, tool or environment.

If it's not possible to curate a small set of useful rules for this situation, then the template is not a good fit for this collection.

If a template is mostly a list of files installed by a particular version of some software (e.g. a PHP framework), it could live under the community directory. See versioned templates for more details.

If you have a small set of rules, or want to support a technology that is not widely in use, and still believe this will be helpful to others, please read the section about specialized templates for more details.

Include details when opening a pull request if the template is important and visible. We may not accept it immediately, but we can promote it to the root at a later date based on interest.

Please also understand that we can’t list every tool that ever existed. Our aim is to curate a collection of the most common and helpful templates, not to make sure we cover every project possible. If we choose not to include your language, tool, or project, it’s not because it’s not awesome.

Contributing guidelines

Please see our Contributing Guidelines.

Versioned templates

Some templates can change greatly between versions, and if you wish to contribute to this repository we need to follow this specific flow:

This helps ensure users get the latest version (because they'll use whatever is at the root) but helps maintainers support older versions still in the wild.

Specialized templates

If you have a template that you would like to contribute, but it isn't quite mainstream, please consider adding this to the community directory under a folder that best suits where it belongs.

The rules in your specialized template should be specific to the framework or tool, and any additional templates should be mentioned in a comment in the header of the template.

For example, this template might live at community/DotNet/InforCRM.gitignore:

# gitignore template for InforCRM (formerly SalesLogix)
# website: https://www.infor.com/products/customer-experience-suite/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

Contributing workflow

Here’s how we suggest you go about proposing a change to this project:

  1. Fork this project to your account.
  2. Create a branch for the change you intend to make.
  3. Make your changes to your fork.
  4. Send a pull request from your fork’s branch to our main branch.

Using the web-based interface to make changes is fine too, and will help you by automatically forking the project and prompting to send a pull request too.

License

CC0-1.0.

gitignore (github/gitignore)

Searching Database…

176K ·GitHub
Gitignore
Что это такое?Официальная коллекция шаблонов .gitignore от GitHub: готовые правила игнорирования для популярных языков, инструментов и операционных систем, а также список, на котором работают селекторы .gitignore на GitHub.com.
Это один большой файл игнорирования или набор отдельных шаблонов?Отдельные файлы-шаблоны, разложенные по трём папкам: root — для популярных языков и технологий, Global — для редакторов, инструментов и операционных систем, community — для специализированных.
Как вообще воспользоваться одним из этих шаблонов?Скопируйте шаблон, подходящий для вашего стека, в свой репозиторий в виде файла с именем .gitignore. Для шаблонов из Global README рекомендует использовать ваш глобальный gitignore или объединить их с шаблонами для конкретного проекта.
Найду ли я шаблон для любого языка или инструмента, которые использую?Не обязательно. Сопровождающие специально отбирают только самые распространённые и полезные шаблоны, так что если какого-то инструмента нет — его исключили намеренно, а не потому, что он плохой.
Могу ли я использовать эти шаблоны в своих проектах?Да. Вся коллекция распространяется по лицензии CC0-1.0, поэтому шаблоны можно свободно копировать и адаптировать.
Каким должен быть шаблон, чтобы его приняли?Небольшой и осмысленный набор правил игнорирования, который помогает репозиторию Git работать с одним конкретным языком, фреймворком, инструментом или окружением. Если такого компактного набора собрать нельзя, шаблон не подходит для этой коллекции.
Почему у некоторых шаблонов в имени файла есть номер версии?Шаблоны, которые сильно меняются между версиями, устроены так: в root лежит текущая поддерживаемая версия без номера в имени, а старые версии находятся в community/ с номером версии прямо в имени файла.
What are similar projects?awesome-dotfiles, git-flight-rules, golang-developer-roadmap, python-patterns, architecture-decision-record, every-programmer-should-know, awesome, awesome-awesomeness
Which topics is it in?rules, patterns, templates, dotfiles, version-control, configuration, collection, best-practices, programming, github, git, reference
Creator
github
Size
3.1 MB
Stars
176K
Updated
CommitOct 02
Age
15y
Commits · 90 Days