Project

General

Profile

Порядок разработки

  • В самом начале необходимо однократно выполнить клонирование репозитория проекта:
* Внесите требуемые изменения и выполните соответствующие коммиты в локальный репозиторий. Подробнее смотрите «Рекомендации по выполнению коммитов» ниже.
* Отправить свои изменения в центральный репозиторий
  • Оповестить ответственного за проект об изменениях, если необходимо.

  • Перед началом следующего этапа разработки следует обновить свою локальную копию репозитория с сервера:



Рекомендации по выполнению коммитов

  • Коммит выполняется по окончании решения какой-либо задачи или её относительно самостоятельной части.

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

  • Если в процессе разработки добавлялись, удалялись, перемещались или переименовывались файлы, необходимо явно сообщить системе контроля версий об этих изменениях. Для этого используются команды

hg add имя_файла(ов)
hg remove имя_файла(ов)
hg mv имя_файла(ов)
  • Перед осуществлением коммита:

    • проверьте, что модульные тесты выполняются успешно;
    • проверьте, что написаны документационные комментарии;

hg status

и убедитесь в отсутствии изменений файлов, которые не должны были изменяться, неотслеживаемых файлов (обозначены знаком вопроса) или потерянных файлов (обозначены восклицательным знаком);

  • выполните команду
hg diff
  • Сообщение коммита пишется от первого лица в настоящем времени с опущенным местоимением I, например:
Add something useful (refs #23)
  • Старайтесь, чтобы текст коммита был максимально коротким и понятным. Обязательно оцените, насколько легко будет понять, что было сделано, человеку, который последние два часа не занимался решением вашей задачи и не видел вашего кода. :)

  • Текст сообщения завершается ссылкой на номер выполняемой (выполненной) задачи в трекере в скобках, предваряемой словом refs для незавершённых задач (промежуточные коммиты), fixes для исправленных багов, closes для прочих завершённых задач, resolves для задач, которые необходимо проверить.

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

  • После выполнения коммита необходимо выполнить регистрацию времени, затраченного на решение задачи, в трекере (log time).