Начнем с описания первых шагов по началу работы с GitHub-организацией ЯрГУ. GitHub-организацией — это общий аккаунт, в котором участники могут управлять своими проектами, используя свой личный аккаунт GitHub. GitHub-организацией Ярославского государственного университета им. П.Г. Демидова предназначена для хранения, управления и публикации исследовательских проектов. Ниже ты найдешь инструкции по подключению к организации и общие инструкции по её использованию. Внизу страницы приведены ресурсы по основам использования Git для контроля версий.
Описания лучших практик приведены по ссылке Лучшие практики по Git @uniyar.
Членство в GitHub-организации Ярославского государственного университета им. П.Г. Демидова, включая доступ ко внутренним репозиториям, ограничено сотрудниками ЯрГУ. Чтобы стать членом, используй существующую личную учетную запись GitHub. если у тебя еще нет аккаунта, пожалуйста, создай его. Далее следует запросить доступ на корпоративном портале, оставив сообщение для указанного пользователя. Вся деятельность в рамках GitHub-организации будет интегрирована в личный профиль GitHub (который можно рассматривать как своего рода резюме). Помимо вклада (работы) в GitHub-организации ЯрГУ там будут отображаться вклады и в другие организации GitHub или личные репозитории.
-
Создай личный GitHub-аккаунт (не нужно делать, если личный GitHub-аккаунт уже существует).
-
Зайди в личный GitHub-аккаунт.
-
Настрой двухфакторную аутентификацию для своей учетной записи GitHub.
-
Присоединись к GitHub-организации ЯрГУ, запросив доступ на корпоративном портале.
-
Дождись ответа от администратора.
-
Переходи на https://github.com/uniyar и приступай к работе!
Чтобы получить первоначальный доступ к GitHub-организации ЯрГУ, выполни описанные выше действия.
|
Warning
|
После включения двухфакторной аутентификации для личного GitHub-аккаунта ты больше не сможешь подключаться к своим удалённым репозиториям, используя HTTPS-ссылки в сочетании с паролем от GitHub. Вместо этого тебе нужно будет настроить SSH-ключ или Персональный токен доступа. Это действие выполняется один раз. После этого взаимодействие с GitHub будет таким же, как и раньше. |
Используй SSH-ключ или Персональный токен доступа (Personal Access Token, PAT), чтобы получить доступ к своим ресурсам из командной строки, смотри инструкции по использованию двухфакторной аутентификации с командной строкой. Эти ключи должны быть авторизованы для использования в GitHub-организации ЯрГУ. При использовании SSH-ключа тебе нужно будет изменить URL-адреса удаленных репозиториев с HTTPS-схемы на SSH-схему. При использовании PAT (персонального токена доступа) можешь продолжать использовать HTTPS-ссылки. Вот инструкции:
-
SSH доступ:
-
Создание SSH-ключа.
-
Авторизация SSH-ключа для использования в GitHub-организации ЯрГУ.
-
Изменение URL-адресов всех существующих репозиториев с HTTPS на SSH.
-
-
PAT доступ:
Используй эту GitHub-организацию для исследовательских проектов или других работ, связанных с ЯрГУ. Не следует использовать эту организацию для учебных упражнений или личной деятельности.
Эта GitHub-организация предназначена для управления исходным кодом. Не рекомендуется использовать GitHub для хранения наборов данных с личными или конфиденциальными данными. Однако для контроля версий документов или небольших обезличенных наборов данных её вполне можно использовать. При возникновении сомнений не мешкая обращайся за советом к нам.
Будь в курсе общих университетских правил использования информационных систем и лучших практик безопасности для GitHub.
Если вы новичок в Git, обязательно изучите основы управления версиями Git для правильного управления своими проектами. Типичные угрозы включают публикацию данных, которые не должны быть опубликованы, или публикацию паролей. Убедись, что ты знаешь, как указать Git, какие файлы должны или не должны быть под контролем версий, особенно если работа связана с какими-либо конфиденциальными данными. Наконец, имей в виду, что если какие-либо сторонние приложения авторизованы на доступ к твоему аккаунту или к аккаунту кого-то из коллег, то эти приложения могут иметь доступ к данным в ваших частных репозиториях.
Ты можешь использовать GitHub Pages для продвижения исследовательских проектов, например, публикуя веб-сайт проекта. Для целей дизайна можно использовать логотип ЯрГУ. Однако следует воздержаться от копирования дизайна, относящегося к корпоративному веб-сайту университета.
Используй названия репозиториев, которые описывают проект. Не используй названия, которые могут быть какими-то двусмысленными, особенно когда они связаны с законом или политикой (например, названия репозиториев, содержащие policy или terms). Мы оставляем за собой право переименовывать репозитории с двусмысленными названиями. В случае сомнений свяжись с нами.
Обязательно добавь лицензию к своей работе, поскольку она определяет правила для людей, которые хотят использовать твой код/программное обеспечение. Если ты используешь повторно лицензированное программное обеспечение, убедись, что выбранная тобой лицензия совместима с лицензией переиспользованного программного обеспечения. Помощь в выборе лицензии.
Как только ты попадешь в GitHub-организацию ЯрГУ, следуя описанным выше шагам, тебе будет предоставлено разрешение на создание репозиториев в организации. Изучи документацию GitHub для получения инструкций по созданию репозитория.
Создавай команды для управления репозиториями и формированием группы коллег, работающих над проектом. Сразу после попадании в GitHub-организацию ЯрГУ у тебя будет возможность создавать команды. Изучи документацию GitHub для получения инструкций по созданию команды. Подробнее о том, как управлять командой в GitHub-организации ЯрГУ.
После создания репозитория или команды ты автоматически получишь возможность добавлять участников. Когда ты приглашаешь человека в команду, он автоматически получает приглашение на вступление в GitHub-организацию ЯрГУ. Если ты хочешь пригласить коллегу в репозиторий без использования команд GitHub, коллега должен сначала стать членом GitHub-организации через описанные выше шаги. Если коллега является членом GitHub-организации ЯрГУ, ты можешь пригласить его для совместной работы над репозиториями.
Ты можешь приглашать партнеров из сторонних организаций или студентов для совместной работы над репозиториями. Для этого добавь их в качестве внешних сотрудников (external collaborator) в репозитории: см. документацию GitHub. Будь ответственным при приглашении внешних сотрудников; приглашай их только в те репозитории, к которым им действительно нужен доступ.
Возможно ты захочешь перенести существующий репозиторий в эту GitHub-организацию ЯрГУ. Для этого используй функцию зеркалирования.
|
Warning
|
Не используй опцию «Передать собственность» в настройках репозитория для перемещения репозитория в эту GitHub-организацию ЯрГУ. Так ты потеряешь административные права на репозиторий. |
Минуты и пространство в сервисе GitHub Actions являются неограниченными для публичных репозиториев. Всегда, когда возможно, используй публичные репозитории при работе с GitHub Actions. В GitHub Actions на уровне организации существуют месячные лимиты ресурсов на использование в частных репозиториях. Как только эта квота будет израсходована, минуты GitHub Actions будут отключены для частных репозиториев на оставшуюся часть месяца.
Использование системы контроля версий Git является ключевым элементом в парадигме открытой науки и помогает управлять версиями файлов, налаживать сотрудничеством и публиковать свои результаты. Новичку в Git стоит уделить время для ознакомления с методами работы. Однодневный курс поможет тебе начать.
Ресурсы:
Мы очень рады любым предложениям или исправлениям для улучшения контента. Цель этого репозитория — помочь сотрудникам Ярославского государственного университета им. П.Г. Демидова начать работу с GitHub-организацией ЯрГУ. Прочитай руководство по участию.
Содержание этого репозитория лицензировано в соответствии с Creative Commons Zero 1.0 (передача в общественное достояние).
Тебе нужна помощь или у есть другие пожелания? Создай ишью (issue) или напиши по электронной почте github@uniyar.ac.ru. Мы также будем рады всем желающим внести вклад в этот репозиторий.