Hello World

Введение

GitHub AE — это платформа размещения кода для управления версиями и совместной работы. Она позволяет вам и другим пользователям работать над проектами вместе из любого места.

В этом руководстве вы ознакомитесь с основными понятиями GitHub AE, такими как репозитории, ветви, фиксации и запросы на вытягивание. Вы создадите собственный репозиторий Hello World и ознакомитесь с рабочим процессом запроса на вытягивание в GitHub AE — популярного способа создания и проверки кода.

В этом кратком руководстве вы выполните следующие действия:

создадите и используете репозиторий;
создадите ветвь и будете управлять ею;
внесете изменения в файл и отправите их в GitHub AE как фиксации;
откроете запрос на вытягивание и выполните его слияние.

Для работы с этим руководством вам потребуются учетная запись GitHub AE и доступ к Интернету. Вам не нужно знать, как писать код, использовать командную строку или устанавливать GIT (программное обеспечение для управления версиями, на котором основывается GitHub AE). Если у вас возникнет вопрос касательно любого из выражений, используемых в руководстве, перейдите к глоссарию, чтобы узнать больше о нашей терминологии.

Создание репозитория

Репозиторий обычно используется для упорядочения одного проекта. Репозитории могут содержать папки и файлы, изображения, видео, электронные таблицы и наборы данных — все, что нужно вашему проекту. Репозитории часто включают файл сведений о проекте. Файлы сведений создаются на языке Markdown в виде обычного текста. Эта памятка поможет вам приступить к работе с синтаксисом Markdown. GitHub AE позволяет добавить файл сведений одновременно с созданием репозитория. GitHub AE также предлагает другие распространенные компоненты, такие как файл лицензии, но пока вам выбирать их не нужно.

В репозитории hello-world можно хранить идеи и ресурсы, а также делиться ими и обсуждать их с другими пользователями.

В правом верхнем углу любой страницы откройте раскрывающееся меню и выберите Новый репозиторий.
В поле "Имя репозитория" введите hello-world.
В поле "Описание" введите краткое описание.
Выберите, будет ли репозиторий общедоступным или частным.
Выберите параметр Добавить файл сведений.
Щелкните Создать репозиторий.

Создание ветви

Ветвление позволяет одновременно иметь разные версии репозитория.

По умолчанию репозиторий имеет одну ветвь с именем main, которая считается главной. В репозитории можно создать дополнительные ветви на основе main. Ветви можно использовать для одновременного использования разных версий проекта. Это полезно, если нужно добавить в проект новые функции, не изменяя основной источник кода. Работа, выполняемая в других ветвях, не будет отражаться в главной ветви, пока вы не выполните ее слияние (этот процесс будет рассмотрен далее в руководстве). Ветви можно использовать для проведения экспериментов и внесения изменений перед их фиксацией в main.

Когда вы создаете ветвь на основе ветви main, создается копия или моментальный снимок main на этот момент времени. Если кто-то другой внес изменения в ветвь main, пока вы работали со своей ветвью, вы можете вытянуть эти изменения.

На этой схеме показано следующее:

ветвь main;
новая ветвь с именем feature;
путь, который проходит feature до слияния с main.

Схема ветвления.

Приходилось ли вам сохранять разные версии файла? Например, так:

story.txt
story-edit.txt
story-edit-reviewed.txt

Ветви в репозиториях GitHub AE служат аналогичным целям.

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

Создание ветви

В репозитории hello-world перейдите на вкладку Код.
Над списком файлов щелкните раскрывающееся меню с надписью main.
В текстовом поле введите имя ветви readme-edits.
Нажмите кнопку Создать ветвь readme-edits на основе main.

Теперь у вас две ветви: main и readme-edits. Сейчас они выглядят совершенно одинаково. Далее вы добавите изменения в новую ветвь.

Внесение и фиксация изменений

После создания ветви на предыдущем шаге в GitHub AE открылась страница кода для новой ветви readme-edits, которая является копией ветви main.

Вы можете вносить изменения в файлы в репозитории и сохранять их. В GitHub AE сохраненные изменения называются фиксациями. С каждой фиксацией связано сообщение о фиксации, в котором объясняется, почему было внесено данное изменение. В сообщениях о фиксациях ведется история изменений, чтобы другие участники могли понять, что вы сделали и почему.

В созданной ветви readme-edits щелкните файл README.md.
Чтобы изменить файл, щелкните .
В редакторе напишите немного о себе. Попробуйте использовать различные элементы Markdown.
В поле "Фиксация изменений" напишите сообщение о фиксации, описывающее изменения.
Щелкните Зафиксировать изменения.

Эти изменения будут внесены только в файл сведений в вашей ветви readme-edits, поэтому теперь ее содержимое отличается от main.

Открытие запроса на вытягивание

Теперь, когда у вас есть изменения в ветви, созданной на основе main, можно открыть запрос на вытягивание.

Запросы на вытягивание — это основа совместной работы на GitHub AE. Когда вы открываете запрос на вытягивание, вы предлагаете свои изменения и просите, чтобы кто-нибудь проверил результаты вашей работы, извлек их и выполнил слияние со своей ветвью. В запросах на вытягивание показаны различия в содержимом двух ветвей. Изменения, дополнения и исключения отображаются разными цветами.

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

Используя функцию GitHub AE @mention в сообщении с запросом на вытягивание, вы можете запросить отзывы от конкретных пользователей или команд независимо от того, где они находятся физически — этажом ниже или на другом конце света.

Вы даже можете открывать запросы на вытягивание в собственном репозитории и выполнять их слияние самостоятельно. Это отличный способ ознакомиться с процессом работы на GitHub AE перед работой над крупными проектами.

В репозитории hello-world перейдите на вкладку Запросы на вытягивание.
Щелкните Новый запрос на вытягивание.
В поле Примеры сравнения выберите созданную вами ветвь readme-edits, чтобы сравнить ее с main (исходной ветвью).
Просмотрите различия на странице сравнения и убедитесь в том, что они готовы к отправке.
Щелкните Создать запрос на вытягивание.
Укажите заголовок запроса на вытягивание и напишите краткое описание изменений. Вы можете добавлять эмодзи и перетаскивать изображения и GIF-файлы.
При необходимости справа от названия и описания щелкните рядом с элементом Рецензенты, Уполномоченные, Метки, Проекты или Веха, чтобы добавить любые из этих элементов в запрос на вытягивание. Пока их добавлять не нужно, но эти параметры обеспечивают различные способы совместной работы с помощью запросов на вытягивание. Дополнительные сведения см. в разделе Сведения о запросах на вытягивание.
Щелкните Создать запрос на вытягивание.

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

Слияние запроса на вытягивание

На этом последнем шаге вы выполните слияние ветви readme-edits с ветвью main. После слияния запроса на вытягивание изменения в вашей ветви readme-edits будут включены в main.

Иногда запрос на вытягивание может вносить изменения в код, конфликтующие с существующим кодом в main. Если есть конфликты, GitHub AE оповещает вас об этом и блокирует слияние до их устранения. Вы можете выполнить фиксацию, которая устраняет конфликты, или использовать комментарии в запросе на вытягивание, чтобы обсудить конфликты с участниками команды.

При выполнении этого пошагового руководства конфликтов не должно быть, поэтому ваша ветвь готова к слиянию с главной.

В нижней части запроса на вытягивание щелкните Объединить запрос на вытягивание , чтобы объединить изменения в main.
Щелкните Подтвердить слияние. Вы получите сообщение о том, что запрос был успешно объединен и закрыт.
Щелкните Удалить ветвь. Теперь, когда запрос на вытягивание объединен и изменения включены в main, вы можете спокойно удалить ветвь readme-edits. Чтобы внести дополнительные изменения в проект, вы всегда можете создать новую ветвь и повторить этот процесс.

Дальнейшие действия

В этом руководстве вы узнали, как создать проект и отправить запрос на вытягивание на GitHub AE.

Вы выполнили следующие задачи:

создали репозиторий с открытым кодом;
создали ветвь и управляли ею;
изменили файл и зафиксировали изменения в GitHub AE;
открыли запрос на вытягивание и выполнили его слияние.

Откройте свой профиль GitHub AE, и вы увидите, что на графике участия отразились результаты вашей работы.

Дополнительные сведения о возможностях ветвей и запросов на вытягивание см. в разделе GitHub Flow. Дополнительные сведения о начале работы с GitHub AE см. в других кратких руководствах.

Hello World

В этой статье