gitignore

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

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

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

• Глава игнорирующих файлов книги Pro Git.
• Статья игнорирующих файлов на сайте справки GitHub.
• Гитиньоре (5) Страница ручной работы.

Структура папки

Мы поддерживаем коллекцию шаблонов, организованных таким образом:

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

Что делает хороший шаблон?

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

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

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

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

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

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

Внесение руководящих принципов

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

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

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

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

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

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

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

Версии шаблонов

Некоторые шаблоны могут сильно измениться между версиями, и если вы хотите внести свой вклад в этот репозиторий, мы должны следовать этому конкретному потоку:

• Шаблон в корне должен быть текущей поддерживаемой версией
• Шаблон в корне не должен иметь версию в имени файла (то есть «Evergreen»)
• Предыдущие версии шаблонов должны жить под community/
• Предыдущие версии шаблона должны встроить версию в имя файла для читаемости для читаемости

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

Специализированные шаблоны

Если у вас есть шаблон, который вы хотели бы внести свой вклад, но он не совсем мейнстрим, пожалуйста, подумайте о добавлении этого в каталог community в папке, которая лучше всего подходит.

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

Например, этот шаблон может жить в 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

Вклад рабочий процесс

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

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

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

Лицензия

CC0-1.0.