Pull to refresh

Систематизация коммитов

Website development *
Часто ли вам приходилось просматривать список изменений что бы понять — затронуло ли оно вас?
Хотели бы вы бегло просмотрев комментарий знать всю необходимую информацию?
Хочу поделиться сокращениями устоявшимися в нашей команде.

  • :: подсистема
  • = Создал новое. Аналогия: int a = 30;
  • + Добавил метод/функционал
  • — Удалил (устарело к примеру)
  • ~ Изменил оставив совместимым(малый рефактор)
  • ; Логически работа/этап завершен.
  • @ Оптимизация. (Символ похож на улитку)
  • * BugFix
  • % Разделено на два модуля/подфункции
  • & Упростил логику (была лажа какая то)
  • $ Добавил поддержку. (Эволюционировало !SUPPORT->!S->$)
  • ? Требует внимания, обсуждения. Не уверен что правильно.
  • ! Несовместимые изменения, требует внимания
  • ` Минорное изменение.
  • | Чего добивались(что было изображено на доске заданий)
  • \, / — ветвление


Это то что мы регулярно используем, и требуется постоянно.
Список совсем не полный(событий коммитов гораздо больше), но остальное мы пока не систематизировали.
Символов для вашего творчества оставили очень много.
Примеры

Рефакторил внутреннюю логику манагера, и исправил багу в методе Run.
~ task_manager
* task_manager::Run(num)

Разработка манагера уходит в отдельную ветку. Планируется множество несовместимых черновых изменений.
/ task_manager

Работа над простым заданием завершена, его мы отделяем в коммит, что бы потом сделать merge с основной веткой.
\ task_manager::simple_task

Подробный комментарий.
Статус изменения подсистемы — совместима, добавился функционал, упростилась логика и коммит логически завершенный.
base::exception: ~+&;
  |  Эксепшены которые не подразумевают аварийное завершение программы
  ~ Методы константные по логике - стали такими
  * Потеря памяти при переопределении чего то там
  % Теперь есть fatal_exception и operation_fail
  ? Возможность подписки на событие ошибки


Я буду очень рад если мне предложат еще какие идеи, жду вашего отклика в комментариях.
Tags:
Hubs:
Total votes 43: ↑29 and ↓14 +15
Views 10K
Comments Comments 43