Сведения об отправке репозитория
Только общедоступные репозитории, принадлежащие личным учетным записям, можно отправить в GitHub Community Exchange.
Доступно три типа отправки репозитория:
- Обучение. Репозиторий для предоставления общего доступа к пошаговым инструкциям по созданию проекта.
- Совместная работа. Репозиторий, которому требуются участники совместной работы для работы над проектом.
- Обучение и совместная работа. Репозиторий, который представляет собой комбинацию
Learn
иCollaborate
.
Следует учитывать основное назначение репозитория при выборе типа отправки для репозитория.
Чтобы повысить уровень проекта и его доступность для обнаружения другими учащимися, необходимо назначить один или несколько разделов? а также предложения GitHub Student Developer Pack своему репозиторию. Дополнительные сведения см. в разделе Классификация репозитория с помощью тем.
После отправки репозитория в GitHub Community Exchangeон будет сразу же опубликован с выбранным назначением, темой и предложениями. Сообщество GitHub Community Exchange модерирует все отправки репозитория.
Требования к отправке
Чтобы отправка была принята, репозиторий должен соответствовать минимальному набору требований. Если условия отправки для выбранного репозитория не выполнены, вы получите уведомление об отсутствующих элементах.
Для отправки с назначением Learn
репозиторий должен содержать:
- Описание.
- Файл LEARN.md, в котором представлены пошаговые инструкции с текстом и (или) мультимедийными данными, демонстрирующими создание проекта. В идеале файл LEARN.md деконструирует проект на небольшие компоненты и предоставит подробные сведения о каждом этапе, чтобы другие учащиеся могли написать код своего проекта, следуя инструкциям.
- Файл README.md, в котором приведено подробное описание проекта.
- Лицензия, поэтому другие знают о том, что они могут и не могут сделать с исходным кодом.
Для отправки с назначением Collaborate
репозиторий должен содержать:
- Описание.
- Файл README.md, в котором приведено подробное описание проекта.
- Лицензия, поэтому другие знают о том, что они могут и не могут сделать с исходным кодом.
- Одну или несколько проблем, над которыми будут работать участники совместной работы.
- CONTRIBUTING.md файл, чтобы сообщить о том, как внести свой вклад в проект.
Грамотная отправка репозитория с назначением Learn
и Collaborate
— это репозиторий, который соответствует стандартам сообщества. Дополнительные сведения см. в разделе Сведения о профилях сообщества для общедоступных репозиториев.
Отправка репозитория
- В GitHub Education, перейдите на главную страницу GitHub Community Exchange.
- Над списком репозиториев справа от фильтров поиска и раскрывающегося списка нажмите кнопку Добавить репозиторий.
- Во всплывающем окне используйте раскрывающееся меню "Что такое назначение отправки" и выберите одну или несколько записей, соответствующих вашей отправке.
- Используйте раскрывающееся меню Репозиторий для использования и выберите репозиторий для отправки. Если условия отправки не выполнены, вы получите уведомление о отсутствующих элементах, и вы можете нажать кнопку "Изменить репозиторий", если вы хотите просмотреть репозиторий и внести изменения в соответствие с критериями.
- Используйте раскрывающееся меню Предложения, использованные для проекта и выберите одну или несколько записей, соответствующих вашей отправке.
- Нажмите кнопку Отправить проект.