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

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

В этой статье

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

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

Вы можете добавить файлы работоспособности сообщества по умолчанию в называемый .githubрепозиторий.

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

Примечание.

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

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

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

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

Например, любой пользователь, создающий проблему или запрос на вытягивание в репозитории, у которого нет собственного CONTRIBUTING.md файла, увидит ссылку на ссылку по умолчанию CONTRIBUTING.md из .github репозитория. Однако если репозиторий определяет допустимые шаблоны проблем или конфигурацию шаблона выдачи в собственной .github/ISSUE_TEMPLATE папке, ни одно из содержимого папки по умолчанию .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 отображает кнопку спонсора в вашем репозитории, чтобы повысить видимость вариантов финансирования для вашего проекта с открытый код. Дополнительные сведения см. в разделе Отображение кнопки спонсора в репозитории.
Шаблоны проблем и запросов на вытягивание и файл config.ymlШаблоны запросов на вытягивание и проблемы настраивают и стандартизируют сведения, которые вы хотите включить при открытии проблем и запросах на вытягивание в репозитории. Дополнительные сведения см. в разделе Сведения о шаблонах проблем и запросов на вытягивание.

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

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

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

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

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

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

Снимок экрана: меню владельца для нового репозитория GitHub. В меню показаны два параметра, октокат и github.

  1. В поле "Имя репозитория" введите github.
  2. При необходимости в поле "Описание" введите описание.
  3. Если вы создаете репозиторий для организация с управляемыми пользователямиобъекта, задайте состояние репозитория внутренним. Для любой другой соответствующей учетной записи задайте состояние Public. Репозиторий для файлов по умолчанию не может быть частным.
  4. Включите параметр «Добавить файл сведений».****
  5. Щелкните Создать репозиторий.
  6. В репозитории создайте один из поддерживаемых файлов работоспособности сообщества. Формы категорий обсуждений должны находиться в папке с именем .github/DISCUSSION_TEMPLATE. Шаблоны проблем и их файл конфигурации должны находиться в папке с именем .github/ISSUE_TEMPLATE. Файл FUNDING.yml должен находиться в папке .github . Все остальные поддерживаемые файлы могут находиться в корневом каталоге репозитория, .github папке или папке docs . Дополнительные сведения см. в разделе Создание новых файлов.