Enterprise Server 3.22 в настоящее время доступен в качестве кандидата на выпуск.

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

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

В этой статье

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

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

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

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

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

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

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

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

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

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

Пример реального 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 сообщает, как люди должны участвовать в проекте. Дополнительные сведения см. в разделе Создание рекомендаций для участников репозитория.
Формы категорий обсужденияФормы категорий обсуждений настраивают шаблоны, доступные для участников сообщества, которые будут использоваться при открытии новых обсуждений в репозитории. Дополнительные сведения см. в разделе Создание форм категорий обсуждений.
Шаблоны проблем и запросов на вытягивание и файл 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. Все остальные поддерживаемые файлы могут находиться в корневом каталоге репозитория, .github папке или папке docs . Дополнительные сведения см. в разделе Создание новых файлов.