Создание файла работоспособности сообщества по умолчанию.

Сведения о файлах работоспособности сообщества по умолчанию

Файлы работоспособности сообщества по умолчанию можно добавить в общедоступный репозиторий .github в корневой каталог репозитория или в папки docs или.github.

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

• Корень репозитория
• Папка .github
• Папка docs

Например, любой пользователь, создающий проблему или запрос на вытягивание в репозитории, у которого нет собственного файла CONTRIBUTING, увидит ссылку на файл CONTRIBUTING по умолчанию. Если в репозитории есть файлы в собственной папке .github/ISSUE_TEMPLATE, включая шаблоны проблем или файл config.yml, содержимое папки по умолчанию .github/ISSUE_TEMPLATE использоваться не будет.

Файлы по умолчанию не включаются в клоны, пакеты или скачивания отдельных репозиториев, так как они хранятся только в репозитории .github.

Поддерживаемые типы файлов

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

Файл работоспособности сообщества | Описание --- | --- CONTRIBUTING.md | Файл CONTRIBUTEING сообщает о том, как люди должны участвовать в проекте. Дополнительные сведения см. в разделе Создание рекомендаций для участников репозитория. Шаблоны проблем и запросов на вытягивание и config.yml | Шаблоны проблем и запросов на вытягивание настраивают и стандартизируют сведения, которые участники должны включать при открытии проблем и запросов на вытягивание в репозитории. Дополнительные сведения см. в разделе Сведения о шаблонах проблем и запросов на вытягивание. SECURITY.md | Файл SECURITY содержит инструкции по сообщению об уязвимости системы безопасности в проекте. Дополнительные сведения см. в разделе Добавление политики безопасности в репозиторий. SUPPORT.md | Файл ПОДДЕРЖКИ позволяет пользователям узнать о способах получения помощи по проекту. Дополнительные сведения см. в разделе Добавление ресурсов поддержки в проект.

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

Создание репозитория для файлов по умолчанию

1. В правом верхнем углу любой страницы откройте раскрывающееся меню и выберите Новый репозиторий.
2. В раскрывающемся меню Владелец выберите организацию или личную учетную запись, для которой нужно создать файлы по умолчанию.
3. Введите .github в качестве имени репозитория и необязательное описание.
4. Убедитесь, что для состояния репозитория задано значение Общедоступный (репозиторий для файлов по умолчанию не может быть частным). 1. Выберите Initialize this repository with a README (Инициализировать репозиторий с помощью файла сведений). 1. Щелкните Создать репозиторий.
5. В репозитории создайте один из поддерживаемых файлов работоспособности сообщества. Шаблоны проблем и их файл конфигурации должны находиться в папке с именем .github/ISSUE_TEMPLATE. Все остальные поддерживаемые файлы могут находиться в корне репозитория, папке .github или папке docs. Дополнительные сведения см. в разделе Создание новых файлов.