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

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

В этой статье

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

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

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

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

Если соответствующий файл в текущем репозитории не найден, GitHub будет использоваться файл по умолчанию из .github репозитория в том же порядке приоритета.

Примечание.

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

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

Хранение файлов в .github репозитории позволяет вносить изменения в значения по умолчанию только в одном месте. Кроме того, они не будут отображаться в браузере файлов или журнале Git отдельных репозиториев и не включены в их клоны, пакеты или загрузки.

В качестве ответственный за репозиторий можно использовать контрольный список стандартов сообщества, чтобы узнать, соответствует ли ваш проект рекомендуемым стандартам сообщества, чтобы помочь пользователям использовать и внести свой вклад в проект. Дополнительные сведения см. в разделе Сведения о профилях сообщества для общедоступных репозиториев.

Сведения о политиках безопасности

После того как кто-то сообщил о уязвимости безопасности в вашем проекте, вы можете использовать GitHub Security Advisories это для раскрытия, исправления и публикации информации о ней. Для получения дополнительной информации о процессе уведомления и раскрытия уязвимостей в GitHub, см. AUTOTITLE. Дополнительные сведения о рекомендациях по безопасности репозитория см. в разделе Сведения о помощниках по безопасности репозитория.

Пример реального SECURITY.md файла см. в разделеhttps://github.com/electron/electron/blob/main/SECURITY.md[](https://github.com/electron/electron/blob/main/SECURITY.md) .

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

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

Файл работоспособности сообществаDescription
CODE_OF_CONDUCT.mdФайл CODE_OF_CONDUCT определяет стандарты для участия в сообществе. Дополнительные сведения см. в разделе Добавление правил поведения в проект.
CONTRIBUTING.mdФайл CONTRIBUTEING сообщает, как люди должны участвовать в проекте. Дополнительные сведения см. в разделе Создание рекомендаций для участников репозитория.
Формы категорий обсужденияФормы категорий обсуждений настраивают шаблоны, доступные для участников сообщества, которые будут использоваться при открытии новых обсуждений в репозитории. Дополнительные сведения см. в разделе Создание форм категорий обсуждений.
FUNDING.ymlФайл FUNDING отображает кнопку спонсора в вашем репозитории, чтобы повысить видимость вариантов финансирования для вашего проекта с открытый код. Дополнительные сведения см. в разделе Отображение кнопки спонсора в репозитории.
GOVERNANCE.mdФайл УПРАВЛЕНИЯ позволяет пользователям узнать, как управляется проект. Например, он может обсудить роли проекта и способ принятия решений. Для получения дополнительной информации см. раздел «Лидерство и управление — руководства по открытому исходному коду».
Шаблоны проблем и запросов на вытягивание и файл config.ymlШаблоны запросов на вытягивание и проблемы настраивают и стандартизируют сведения, которые вы хотите включить при открытии проблем и запросах на вытягивание в репозитории. Дополнительные сведения см. в разделе Сведения о шаблонах проблем и запросов на вытягивание.

Если шаблон выпуска устанавливает метку, эта метка должна быть создана в вашем .github репозитории и в любых репозиториях, где шаблон будет использоваться. Шаблоны выпусков и pull запросов по всей организации требуют .github , чтобы репозиторий был публичным.
SECURITY.mdФайл SECURITY содержит инструкции о том, как сообщить об уязвимости безопасности в проекте и описании, который гиперссылки на файл. Дополнительные сведения см. в разделе Добавление политики безопасности в репозиторий.
SUPPORT.mdФайл ПОДДЕРЖКи позволяет людям узнать о способах получения справки по проекту. Дополнительные сведения см. в разделе Добавление ресурсов поддержки в проект.

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

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

  1. В правом верхнем углу любой страницы выберите , а затем нажмите кнопку "Создать репозиторий".

    Снимок экрана: раскрывающееся меню GitHub с параметрами создания новых элементов. Пункт меню "Новый репозиторий" описан в темно-оранжевый.

  2.           **Используйте раскрывающееся меню "Владелец"** и выберите организацию или личная учетная запись, для которой вы хотите создать файлы по умолчанию.

       ![Снимок экрана: меню владельца для нового репозитория GitHub. В меню показаны два параметра, октокат и github.](/assets/images/help/repository/create-repository-owner.png)

  3. В поле "Имя репозитория" введите github.

  4. При необходимости в поле "Описание" введите описание.

  5. Убедитесь, что статус репозитория установлен как Публичный или Внутренний. Репозиторий для файлов по умолчанию не может быть частным.

  6. Включите параметр «Добавить файл сведений».****

  7. Щелкните Создать репозиторий.

  8. В репозитории создайте один из поддерживаемых файлов работоспособности сообщества. Шаблоны проблем и их файл конфигурации должны находиться в папке с именем .github/ISSUE_TEMPLATE. Все остальные поддерживаемые файлы могут находиться в корне репозитория, папке .github или папке docs. Дополнительные сведения см. в разделе Создание новых файлов.