Документация очень полезна для любого типа программирования. Это помогает нам легко понять код. Кодер может через долгое время забыть о функции написанного им кода. Но если код хорошо документирован, то кодировщик или кто-либо другой могут легко понять функцию кода в любое время из документации. Информация о конкретном файле и папке GitHub может быть установлена, как документация, с помощью сообщения фиксации Git. Когда репозиторий git публикуется в GitHub, сообщение фиксации по умолчанию добавляется к каждому файлу и папке, функция которых для конкретного файла или папки не определена четко. Пользователь git может добавить настраиваемое сообщение фиксации для каждого файла или папки, четко определяющее назначение этого файла или папки. В этом руководстве объясняется, как добавить сообщение о фиксации git.
Предварительные условия:
Установка GitHub Desktop
GitHub Desktop помогает пользователю git выполнять задачи, связанные с git, графически. Вы можете легко загрузить установщик последней версии этого приложения для Ubuntu с github.com. Вам необходимо установить и настроить это приложение, чтобы использовать его после загрузки. Вы также можете проверить руководство по установке GitHub Desktop в Ubuntu, чтобы правильно узнать процесс установки.
Создание учетной записи GitHub
Вам потребуется создать учетную запись GitHub, чтобы проверить добавленное сообщение фиксации на удаленном сервере.
Создание локального и удаленного репозитория.
Вы должны создать локальный репозиторий для проверки команд, используемых в этом руководстве, чтобы добавить сообщение о фиксации git. Затем вам нужно опубликовать локальный репозиторий в своей учетной записи GitHub, чтобы проверить сообщение о фиксации.
Добавить сообщение о фиксации:
Откройте терминал и перейдите в расположение локального репозитория. Выполните следующую команду, чтобы инициализировать git перед добавлением сообщения о фиксации.
$ git init
Выполните следующую команду, чтобы проверить, было ли какое-либо сообщение зафиксировано ранее, а также список отслеживаемых и неотслеживаемых файлов:
$ git commit
Следующие выходные данные показывают, что папка репозитория содержит файл и папку, которые не отслеживаются, и ранее не добавлялось сообщение о фиксации.
Создайте файл readme.txt в текущей папке репозитория и выполните следующую команду, чтобы добавить файл в репозиторий:
$ git add readme.txt
Выполните следующую команду, чтобы добавить первое сообщение фиксации для репозитория:
$ git commit -m "Базовое руководство по PHP"
В выводе текстовый файл и сообщение фиксации были добавлены в локальный репозиторий.
Измените сообщение фиксации:
Вы можете изменить сообщение фиксации после добавления нового файла и папки в локальный репозиторий. Выполните следующие команды, чтобы добавить папку загрузки и файл test.php в репозиторий, который ранее не отслеживался.
$ git add upload $ git add test.php
Выполните следующую команду, чтобы добавить новое сообщение фиксации для локального репозитория.
$ git commit -m " Учебники по основам PHP"
Следующий вывод появится после выполнения трех вышеуказанных команд. Выходные данные показывают, что test.php и папка загрузки с upload.php были добавлены в репозиторий, а для этих файлов и папки было добавлено сообщение фиксации «PHP Basic tutorials».
Теперь откройте указанный выше локальный репозиторий на рабочем столе GitHub и нажмите опцию «Опубликовать репозиторий», чтобы опубликовать репозиторий на удаленном сервере.
Появится следующее диалоговое окно для выбора удаленного сервера и установки имени репозитория для удаленного сервера. В этом руководстве для публикации репозитория использовалась учетная запись github.com. Итак, GitHub.com был выбран в качестве удаленного сервера, а имя репозитория было установлено на PHP. Чтобы сохранить частный репозиторий на удаленном сервере, перед публикацией репозитория была выбрана опция «Сохранить этот код частным».
Следующая информация будет отображаться при открытии ранее опубликованного репозитория с github.com. Здесь отображаются три сообщения о фиксации. «Начальная фиксация» добавлена GitHub. «Базовые учебные пособия по PHP» и «Базовые учебные пособия по PHP» – это настраиваемые сообщения фиксации; они были добавлены раньше.
Добавить сообщение фиксации с описанием для конкретной папки:
В предыдущих двух командах фиксации сообщения фиксации были установлены для всех добавленных файлов и папок. Но вы можете добавить сообщение фиксации с описанием для любого конкретного файла или папки. Если вы хотите добавить сообщение фиксации в локальный репозиторий после публикации репозитория, вам необходимо повторно инициализировать репозиторий. Выполните следующие команды, чтобы повторно инициализировать репозиторий, который удалит все ранее добавленные файлы и папки из репозитория.
$ rm -rf.git/ $ git init
Теперь выполните следующую команду, чтобы добавить папку загрузки в локальный репозиторий:
$ git add upload
Выполните следующую команду git commit, чтобы добавить сообщение фиксации с описанием папки загрузки. Здесь «Загрузить файл» – это заголовок сообщения фиксации, а «Использование PHP-скрипта» – это описание сообщения фиксации. Когда пользователь удерживает указатель мыши на заголовке сообщения, после публикации репозитория будет отображаться описание сообщения с заголовком.
$ git commit upload -m "Загрузить файл" -m "Использование PHP-скрипта"
Опубликуйте репозиторий с именем PHP2 в частном режиме с помощью приложения GitHub Desktop, которое было показано в предыдущей части этого руководства. Откройте репозиторий с удаленного сервера github.com. Когда пользователь будет удерживать указатель мыши на ссылке «Загрузить файл», отобразится следующий контент.
Заключение:
Использование значимого сообщения о фиксации помогает пользователям GitHub понять цель использования любого файла или папки репозитория GitHub. Способы добавления нового сообщения о фиксации, изменения сообщения о фиксации и добавления сообщения о фиксации для конкретной папки с описанием и заголовком, все они были показаны в этой статье с использованием демонстрационного репозитория.