How often have you had to look through the list of changes to understand - has it affected you?
Would you like to quickly review a comment to know all the necessary information?
I want to share the abbreviations well-established in our team.
- :: subsystem
- = Created a new one. Analogy: int a = 30;
- + Added method / functionality
- - Removed (outdated for example)
- ~ Changed leaving compatible (small refactor)
- ; Logically work / stage completed.
- @ Optimization. (The character is like a snail)
- * BugFix
- % Divided into two modules / subfunctions
- & Simplified logic (it was some sort of crap)
- $ Added support. (Evolved! SUPPORT ->! S -> $)
- ? Requires attention, discussion. Not sure what is right.
- ! Incompatible changes, requires attention
- `Minor change.
- | What was achieved (what was depicted on the task board)
- \, / - branching
This is something that we regularly use, and is required constantly.
The list is far from complete (there are much more commits), but we have not yet systematized the rest.
There are a lot of symbols for your creativity.
Examples
Refactor the internal logic of the manager, and fixed the bug in the Run method.
~ task_manager * task_manager::Run(num)
Development manager goes into a separate branch. Many incompatible draft changes are planned.
/ task_manager
Work on a simple task is completed, we separate it into a commit, which would then make a merge with the main branch.
\ task_manager::simple_task
Detailed comment.
The subsystem change status is compatible, functionality has been added, logic has been simplified and the commit is logically complete.
base::exception: ~+&; | ~ - * % fatal_exception operation_fail ?
I will be very happy if they offer me any other ideas, I look forward to your response in the comments.