Как залить проект на GitHub: советы и разбор ошибок

У вас есть крутой проект, которым хочется поделиться с другими разработчиками. Или проект, где вы зашли в тупик и хотите получить совет. Рассказываем три способа, как загрузить код на гитхаб.

Что такое Github

Это облачная платформа для хостинга и разработки программного обеспечения. Там можно хранить проекты в репозиториях, управлять версиями кода и работать вместе с другими программистами.

Еще там есть:

• Инструменты для управления проектами, например трекер задач и Kanban-доска;
• Интеграция со сторонними сервисами, например CI/CD;
• Markdown — язык разметки текстовых документов, с помощью которого можно создавать и хранить документацию.

На GitHub можно делиться своими проектами. Там активное сообщество разработчиков и больше 100 миллионов пользователей. 

Как залить проект на Github — самый простой способ

Рассмотрим, как загрузить проект на Github с помощью GitHub Desktop.

Шаг 1. Регистрация

Войдите в уже существующий аккаунт или зарегистрируйтесь. Можно выбрать:

• публичный аккаунт — репозитории видят все пользователи;
• приватный аккаунт — репозитории видят только одобренные участники. 

Желательно также заполнить профиль. Расскажите про свой опыт, образование и навыки, чтобы привлечь потенциальных работодателей. 

Шаг 2. Создание репозитория на Github

Теперь необходимо создать файловое хранилище. В бесплатном аккаунте можно создавать любое число репозиториев, но объем данных не должен превышать 500 Мб. На платном тарифе можно получить больше места в хранилище.

Чтобы создать репозиторий:

1. Кликните «+» в правом верхнем углу экрана и нажмите New repository. 
2. Придумайте имя хранилища и добавьте краткое описание.
3. Выберите приватный доступ (Private) или публичный (Public), если вы хотите поделиться своим проектом с другими.

Можно сразу создать README.md — это файл, который содержит: 

• Описание, что делает проект, его цели и функции;
• Инструкцию по установке;
• Примеры, как использовать проект;
• Информацию о конфигурациях или настройках;
• Инструкцию для тех, кто хочет внести свой вклад.

Также можно добавить .gitignore — список файлов, которые не должны попасть в репозиторий на Github, например кэш и конфиденциальные данные. Отдельно можно указать лицензию, чтобы защитить права разработчика. После этого нажмите Create repository.

Шаг 3. Подготовка локального проекта

Установите GitHub Desktop — это удобное приложение, которое упрощает работу с хранилищем. При первом запуске укажите ваш GitHub-аккаунт. После этого вам предложат:

• Создать новый репозиторий на жестком диске;
• Добавить существующий репозиторий с жесткого диске;
• Клонировать репозиторий из интернета.

Так у нас уже есть репозиторий на Github, скопируем его на ПК:

1. Выберите File → Clone repository.
2. Отметьте хранилище и укажите папку для сохранения.
3. Нажмите Clone.

Теперь репозиторий доступен локально. После этого у вас появятся вкладки: 

• Current Repository — показывает, какой репозиторий открыт в данный момент. Помогает быстро ориентироваться, с чем вы работаете, и легко переключаться между проектами.
• Current Branch — отображает название ветки, с которой вы сейчас работаете. Ветки в Git позволяют работать над новыми функциями или исправлять ошибки, не меняя основной код.  
• Fetch origin — показывает список изменений из удаленного репозитория на GitHub. Полезно для тех, кто работает в команде и хочет знать о действиях других участников.

Шаг 4. Добавление новых файлов

Предположим, мы создали новый файл HTML. Чтобы сохранить изменения в репозитории, откройте GitHub Desktop. 

Наш файл будет лежать в Changes. Напишите описание коммита и выберите Commit to main (или имя вашей текущей ветки). После этого можете перейти в History и просмотреть историю коммитов. Чтобы отправить изменения в репозиторий на Github, нажмите Push origin. 

Теперь проекты в хранилище и на ПК полностью дублируют друг друга. При необходимости вы сможете их восстановить.

Шаг 5. Создание новой ветки

Если хотите поэкспериментировать, но не готовы вносить изменения в основной код, добавьте новую ветку: Current Branch  → New Branch → Create New Branch.

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

Как еще можно загрузить проект в репозиторий на Github

Также загрузить проект можно через консоль или редактор кода, например VS Code:  

1. Авторизуйтесь в GitHub через Visual Studio Code.
2. Откройте Source Control (Контроль версий) в боковой панели.
3. Нажмите Initialize Repository, затем Publish to GitHub.
4. Назовите репозиторий и опубликуйте (Publish).

Этот метод подойдет для тех, у кого уже установлен Git.

Для удобства также можно использовать плагины:

• GitLens: упрощает работу с ветками и сохраняет историю изменений для отдельных файлов и строк.
• Git History: предоставляет удобный интерфейс для просмотра истории коммитов проекта. Можно визуально просматривать ее в виде графа и фильтровать коммиты по автору, сообщению или дате.
• Git Graph: предоставляет визуальную структуру репозитория. Можно увидеть все ветки репозитория и их связи, понять, как они взаимодействуют друг с другом.

Ошибки при загрузке проекта на GitHub 

Чаще всего встречаются:

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

• Отсутствие файла .gitignore: без него в репозиторий на Github могут попасть временные файлы, кэш и конфиденциальная информация.

• Неинформативные коммиты: начинающие разработчики часто пишут неясные или чересчур короткие сообщения, например «изменения» или «обновление». Пишите информативные комментарии, которые объясняют, что было изменено и почему. Это поможет другим участникам.

• Игнорирование лицензии: если не указать лицензию на проект, это может привести к юридическим проблемам и путанице, как можно использовать ваш код.

• Загрузка большого количества данных: загрузка больших файлов увеличивает размер репозитория на Github и уменьшает его производительность. Для хранения изображения или видео используйте Git LFS (Large File Storage).

• Отсутствие документации: без нее пользователи могут не понять, как использовать проект. Пропишите подробную инструкции по установке, использованию и тестированию продукта в README.md, а при необходимости создайте дополнительные файлы.

• Отсутствие ветвления: работа в основной ветке может привести к конфликтам и потере данных. Создавайте отдельные ветки для новых функций или исправления ошибок. 

Следуя этим советам, вы сможете создать качественный и организованный репозиторий, который будет полезен вам и другим разработчикам. 

Главное о том, как залить проект на гитхаб

• GitHub — это большое сообщество разработчиков. На платформу можно загрузить свой проект и найти единомышленников;
• Можно создать публичный или приватный аккаунт, если хотите, чтобы репозитории видели только одобренные участники;
• Загрузка проекта на Github может привлечь потенциальных работодателей, заполните личный профиль, чтобы рассказать о себе больше;
• Поделиться проектом на Github можно через GitHub Desktop, консоль или редактор кода, например VS Code;
• Можно использовать плагины GitLens, Git History и Git Graph, которые упрощают взаимодействие с репозиторием.