Коллекция шаблонов .gitignore

Это коллекция шаблонов файлов .gitignore от GitHub. Мы используем этот список для заполнения доступных в интерфейсе GitHub.com средств выбора шаблонов .gitignore при создании новых репозиториев и файлов.

Для получения дополнительной информации о том, как работают файлы .gitignore и как их использовать, следующие ресурсы станут отличным началом:

• Глава «Игнорирование файлов» книги Pro Git.
• Статья «Игнорирование файлов» на сайте справки GitHub.
• Страница руководства gitignore(5).

Структура папок

Файлы в корневом каталоге предназначены для шаблонов .gitignore, которые относятся к конкретным проектам, например шаблоны для конкретных языков или фреймворков. Шаблоны, применимые ко всем (для операционной системы или редактора), следует помещать в каталог Global/.

Рекомендации по внесению вклада

Мы будем рады, если вы поможете нам улучшить этот проект. Чтобы помочь нам поддерживать высокое качество коллекции, мы просим, чтобы вклад соответствовал следующим рекомендациям:

• Предоставьте ссылку на домашнюю страницу приложения или проекта. Если оно не очень популярно, есть вероятность, что разработчики не знают о языке, фреймворке, редакторе, приложении или проекте, к которому относится ваше изменение.
• Предоставьте ссылки на документацию, подтверждающую изменение, которое вы вносите. Лучше всего подойдёт актуальная каноническая документация, в которой упоминаются игнорируемые файлы. Если документации для подтверждения вашего изменения нет, постарайтесь объяснить, для чего нужны игнорируемые файлы.
• Объясните, почему вы вносите изменение. Даже если это кажется очевидным, пожалуйста, уделите одно или два предложения тому, чтобы рассказать нам, почему ваше изменение или дополнение должно произойти. Особенно полезно сформулировать, почему это изменение применимо ко всем, кто работает с соответствующей технологией, а не только к вам или вашей команде.
• Пожалуйста, учитывайте масштаб вашего изменения. Если ваше изменение специфично для определённого языка или фреймворка, убедитесь, что изменение внесено в шаблон для этого языка или фреймворка, а не в шаблон для редактора, инструмента или операционной системы.
• Пожалуйста, изменяйте только один шаблон за запрос на вытягивание. Это поможет сосредоточить запросы на вытягивание и обратную связь на конкретном проекте или технологии.

В целом, чем больше вы сможете сделать, чтобы помочь нам понять изменение, которое вносите, тем больше вероятность того, что мы быстро примем ваш вклад.

Также поймите, что мы не можем перечислить все существующие инструменты. Наша цель — создать коллекцию наиболее распространённых и полезных шаблонов, а не убедиться, что мы охватываем все возможные проекты. Если мы решим не включать ваш язык, инструмент или проект, это не потому, что он не потрясающий.

Процесс внесения вклада

Вот как мы предлагаем вам внести изменения в этот проект:

1. Форкните этот проект в свой аккаунт.
2. Создайте ветку для изменения, которое собираетесь внести.
3. Внесите изменения в свою форку.
4. Отправьте запрос на вытягивание из ветки вашей форки в нашу основную ветку.

Использование веб-интерфейса для внесения изменений также допустимо и поможет вам автоматически форкнуть проект и предложит отправить запрос на вытягивание тоже. Структура папок

Файлы в корневом каталоге — это шаблоны для .gitignore, которые специфичны для проекта, например, шаблоны, специфичные для языка или фреймворка. Глобальные шаблоны (специфичные для операционной системы или редактора) должны быть помещены в каталог Global/.

Рекомендации по внесению вклада

Мы будем рады, если вы поможете нам улучшить этот проект. Чтобы помочь нам поддерживать высокое качество коллекции, мы просим, чтобы вклад соответствовал следующим рекомендациям:

• Предоставьте ссылку на домашнюю страницу приложения или проекта. Если оно не очень популярно, есть вероятность, что сопровождающие не знают о языке, фреймворке, редакторе, приложении или проекте, к которому относится ваше изменение.

• Предоставьте ссылки на документацию, подтверждающую изменение, которое вы делаете. Лучше всего подходит актуальная каноническая документация, в которой упоминаются файлы, которые игнорируются. Если документация недоступна для поддержки вашего изменения, сделайте всё возможное, чтобы объяснить, для чего используются файлы, которые вы игнорируете.

• Объясните, почему вы вносите изменение. Даже если это кажется очевидным, пожалуйста, напишите предложение или два, чтобы сообщить нам, почему ваше изменение или дополнение должно произойти. Особенно полезно сформулировать, почему это изменение применимо ко всем, кто работает с соответствующей технологией, а не только к вам или вашей команде.

• Пожалуйста, рассмотрите объём вашего изменения. Если ваше изменение специфично для определённого языка или фреймворка, убедитесь, что изменение внесено в шаблон для этого языка или фреймворка, а не в шаблон для редактора, инструмента или операционной системы.

• Пожалуйста, изменяйте только один шаблон на каждый запрос на вытягивание. Это помогает сосредоточить запросы на вытягивание и обратную связь на конкретном проекте или технологии.

В целом, чем больше вы сможете сделать, чтобы помочь нам понять изменение, которое вы вносите, тем больше вероятность того, что мы быстро примем ваш вклад.

Если шаблон представляет собой в основном список файлов, установленных определённой версией некоторого программного обеспечения (например, PHP-фреймворк), то он хрупок и, вероятно, не более полезен, чем простой ls. Если невозможно составить небольшой набор полезных правил, то шаблон может не подходить для этой коллекции.

Также поймите, что мы не можем перечислить все существующие инструменты. Наша цель — создать коллекцию наиболее распространённых и полезных шаблонов, а не убедиться, что мы охватываем все возможные проекты. Если мы решим не включать ваш язык, инструмент или проект, это не потому, что он не потрясающий.

Процесс внесения вклада

Вот как мы предлагаем вам внести изменения в этот проект:

1. Форкните этот проект в свой аккаунт.
2. Создайте ветку для изменения, которое вы собираетесь внести.
3. Внесите изменения в свою форку.
4. Отправьте запрос на вытягивание из ветки вашей форки в нашу основную ветку.

Использование веб-интерфейса для внесения изменений также допустимо и поможет вам автоматически форкнуть проект и предложить отправить запрос на вытягивание.

Лицензия

CC0-1.0.