Именование бранчей, коммитов, пулл реквестов - eugene-okulik/QAP-09onl Wiki

Directories

Каждое домашнее задание должно находиться в отдельной папке внутри вашей папки. Ваша папка - это папка с вашими именем и фамилией внутри папки homework.
Название этой папки должно соответствовать названию задания. Обычно название задания будет выглядеть, например, так: “Homework_3”. Соответственно, и название папки, в котором находится результат домашнего задания должен будет называться “Homework_3”.

Branches

Каждое домашнее задание должно находиться в отдельной ветке. То есть перед выполнением домашнего задания нужно создать новую ветку и работать в ней. Называть ветку нужно по шаблону:
“ваше_имя_название_задания”
Имена веток могут содержать только латинские символы и не могут содержать пробелы.

Пример:

“eugeny_okulik_homework_3”

Commits

Каждый коммит должен отвечать на вопрос “что было сделано?”. При выполнении домашнего задания вы можете все выполнение закоммитить один раз в конце, можете постепенно коммитить на каждом этапе выполнения. Здесь - на ваше усмотрение.
Шаблоны именования коммитов:

При поэтапных коммитах:

“added <что было добавлено>” или “updated <что было изменено>” или “fixed <что было исправлено/починено>”

пример:

“added text variables”, “added funtions for reading text from file” или “updated input text”
Если на английском сложно, то в коммитах можно на русском, например “исправлены пробелы в операциях присвоения”, “изменены названия функций”, или даже подлиннее: “изменен порядок выполнения функций и добавлены проверки корректности данных”

При одном коммите в конце:

“homework_name done”

Пример:

Homework_3 done

При внесении изменений после сдачи:

После того как вы сдали задание, возможно, я оставлю вам комментарий, что нужно что-то поменять или исправить.
Названия коммитов должны говорить о том что было сделано:
“updated <что было изменено>” или “fixed <что было исправлено/починено>”

примеры:

“fixed formatting”, “changed names of variables”, “исправлены пробелы в операциях присвоения”, “изменены названия функций”

Плохо:

“исправил ошибки”, “устранил замечания”, “переделал как просили”, “все исправлено”, "fixed"

Pull requests

Пулл реквест вы создаете тогда, когда считаете, что вы выполнили домашнее задание. То есть создание пулл реквеста - это сдача ДЗ на проверку.

Шаблон:

“Name Secondname: Homework name completed”

Пример:

“eugeny okulik: homework 3 completed”

Недоделанные домашние задания

Если будет ситуация, когда вы что-то делали, уперлись и не знаете что и как делать дальше и хотите спросить совета, то можете создать пулл реквест с названием вроде такого:
"eugeny okulik: homework 3 questions" или "eugeny okulik: homework 3 help"
Названия пул реквестов можно легко менять прямо в гитхабе.