Документация по GitHub открытый код. Любой пользователь может внести свой вклад в документы в общедоступном docs репозитории: https://github.com/github/docs Сотрудники GitHub работают над документацией в копии этого репозитория docs-internal. Эти два репозитория автоматически синхронизируются, чтобы сохранить их в актуальном состоянии с изменениями, объединенными в main ветвь любого репозитория. Для простоты мы рассмотрим "репозиторий документации" в статьях об участии в GitHub Docs.
Репозиторий документации — это место для обсуждения и совместной работы с документацией, опубликованной здесь docs.github.com.
Проблемы
Проблемы используются для отслеживания задач, с которыми могут помочь участники. Если у проблемы есть triage метка, мы еще не рассмотрели ее, и вы не должны начать работу над ней.
Если вы нашли что-то в содержимом документации или что-то о веб-сайте docs.github.com, что должно быть обновлено, выполните поиск открытых проблем, чтобы узнать, сообщил ли кто-то другой об этом же. Если это что-то новое, откройте проблему с помощью шаблона. Мы будем использовать проблему, чтобы иметь беседу о проблеме, которую вы хотите исправить.
Примечание. Сотрудники GitHub должны открывать проблемы в частном docs-content репозитории.
Запросы на включение внесенных изменений
Запрос на вытягивание — это способ предложить изменения в нашем репозитории. При слиянии этих изменений они развертываются на динамическом сайте в течение 24 часов.
Мы не можем принять участие в справочной документации по REST API. Если вы заметили неточность в справочной документации по REST API, откройте проблему в репозитории rest-api-description .
Мы документируем только продукты, компоненты, инструменты и расширения данных GitHub. Мы можем упомянуть или связаться со сторонними инструментами, чтобы продемонстрировать, как работает функция, но мы не принимаем запросы на вытягивание для документа сторонних средств или интеграции, если только они не были кодированы с помощью GitHub.
Просмотр собственных запросов на вытягивание
Прежде чем пометить его как готовый к просмотру другими пользователями, всегда следует сначала просмотреть собственный запрос на вытягивание.
Для изменений содержимого убедитесь, что вы:
- Убедитесь, что изменения соответствуют пользовательскому интерфейсу и целям, описанным в плане разработки содержимого (если есть).
- Просмотрите содержимое для технической точности.
- Проверьте изменения грамматики, орфографии и соблюдения функции AUTOTITLE.
- Убедитесь, что текст в запросе на вытягивание будет легко переводиться. Дополнительные сведения см. в разделе Написание содержимого для перевода.
- Проверьте новые или обновленные инструкции Liquid, чтобы убедиться, что управление версиями правильно. Дополнительные сведения см. в разделе Документация по управление версиями.
- Проверьте предварительный просмотр всех измененных страниц. Предварительная версия создается автоматически после отправки запроса на вытягивание и добавления ссылок в запрос на вытягивание. Предварительная версия иногда занимает несколько минут, прежде чем она будет готова к просмотру. Убедитесь, что все отображается должным образом. Проверка предварительной версии поможет выявить такие проблемы, как опечатки, содержимое, которое не соответствует руководству по стилю, или содержимое, которое не отображается из-за проблем с управлением версиями. Обязательно проверьте отрисованные выходные данные для списков и таблиц, которые иногда могут иметь проблемы, которые трудно определить в Markdown.
- Если в запросе на вытягивание возникли сбои, устраните их до тех пор, пока они не будут пройдены.
Поддержка
Мы небольшая команда трудимся, чтобы следить за требованиями документации к постоянно меняющимся продуктам. К сожалению, мы просто не можем помочь с вопросами о поддержке в этом репозитории. Если у вас возникли проблемы с данными GitHub, не связанной с нашей документацией, обратитесь непосредственно в службу поддержки GitHub. Все проблемы или запросы на вытягивание, открытые в репозитории документации, запрашивающие поддержку, будут предоставлены сведения о том, как связаться с GitHub, а затем закрыть и заблокировать.
Если у вас возникли проблемы с вашей учетной записью GitHub, обратитесь в службу поддержки.
Переводы
Этот веб-сайт является интернационализованным и доступен на нескольких языках. Исходный контент в этом репозитории написан на английском языке. Мы автоматизируем перевод через внутренний процесс, работая с профессиональными переводчиками для локализации содержимого английского языка.
Если вы заметили ошибку перевода, создайте проблему с подробными сведениями.
В настоящее время мы не принимаем запросы на вытягивание для переведенного содержимого.
Политика сайта
также публикуются на docs.github.com.
Если в разделе политики сайта найдите опечатку, можно открыть запрос на вытягивание, чтобы исправить его. Дополнительные сведения см. в разделе "Участие" в репозитории site-policy .