Есть ли обзор того, что может go в каталоге .github "dot github"?

Question

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

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

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

Из-за того, что каталог называется .github, он, похоже, не поддается поиску в Google и SO.

Answer 1

На Github папка .github - это обычная папка, используемая для размещения в ней материалов, связанных с Github. Github обрабатывает некоторые из этих файлов, даже когда вы помещаете их в root вашего проекта (, например CONTRIBUTING.md, CODE_OF_CONDUCT.md et c). Поскольку Github постоянно вводит новые функции, эти функции документируются сами по себе, поэтому на странице «все возможные файлы в .github» нет. Не стесняйтесь размещать в нем все, что связано с Github .

Некоторые из наиболее часто используемых файлов в папке .github:

• CODE_OF_CONDUCT.md -> Как участвовать в сообществе и как себя вести.
• CONTRIBUTING.md -> Как внести свой вклад в репо ( сделать пул-запрос, настроить среду разработки ... )
• FUNDING.yml -> Поддержка проекта
• ISSUE_TEMPLATE -> Папка, содержащая шаблоны возможных проблем, которые пользователь может использовать для открытия проблемы (, например, если проблема связана с документацией, если это ошибка, если пользователь хочет новую функцию и т. д. c) PS Взгляните на tenorflow ISSUE_TEMPLATE
• PULL_REQUEST_TEMPLATE.md -> Как сделать запрос на извлечение проекта
• stale.yml -> Настройка вероятности для устранения устаревших проблем. На Github Marketplace есть много других приложений, которые размещают свои конфигурации в папке .github, потому что они связаны именно с GitHub.
• SECURITY.md -> Как ответственно сообщать об уязвимости безопасности в проекте
• workflows -> Папка конфигурации, содержащая файлы yaml для действий GitHub

---

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