Рекомендации по репозиториям

Узнайте, как эффективно и безопасно использовать репозитории.

В этой статье

Создание ФАЙЛА README

Чтобы упростить понимание и навигацию пользователей, рекомендуется создать файл README для каждого репозитория.

Дополнительные сведения см. в разделе Сведения о файле README репозитория.

Защита репозитория

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

  •         **Dependabot alerts** уведомляет вас об уязвимостях безопасности в сети зависимостей проекта, чтобы можно было обновить затронутую зависимость до более безопасной версии.

  •         **Secret scanning** сканирует репозиторий для секретов (таких как ключи и маркеры API) и предупреждает вас, если секрет найден, чтобы удалить секрет из репозитория.

  •         **Защита** от принудительной отправки не позволяет (и вашим сотрудникам) вводить секреты в репозиторий в первую очередь, блокируя отправки, содержащие поддерживаемые секреты.

  •         **Code scanning** идентифицирует уязвимости и ошибки в коде репозитория, чтобы устранить эти проблемы рано и предотвратить уязвимость или ошибку, эксплуатируемые злоумышленниками.

Кроме того, можно также рассмотреть следующее:

  • Добавление файла в репозиторий SECURITY.md . Файл SECURITY.md содержит инструкции для участников совместной работы о том, как сообщить об уязвимостях безопасности, обнаруженных в проекте, и поощряет ответственное раскрытие информации.

Дополнительные сведения см. в разделе Краткое руководство по защите репозитория.

Пользу ветвления над вилкой

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

Для поддержания качества важных ветвей, таких как mainиспользование ветвления рабочего процесса, можно использовать защищенная ветвь с обязательная проверка состояния и проверка запроса на вытягивание. Дополнительные сведения см. в разделе Сведения о защищенных ветвях.

Использование Хранилище больших файлов Git

Для оптимизации производительности GitHub ограничивает размер файлов, разрешенных в репозиториях. Дополнительные сведения см. в разделе Сведения о больших файлах на GitHub.

Для отслеживания больших файлов в репозитории Git рекомендуется использовать Хранилище больших файлов Git (Git LFS. Дополнительные сведения см. в разделе Сведения о хранилище больших файлов Git Large File Storage.

Отработка практических навыков

Попробуйте упражнение "Общие сведения об управлении репозиториями" для практического взаимодействия с управлением репозиториями.