I would like your opinion regarding a good style/format for short messages when committing into a repository (GIT or SVN).
Considering we are using a feature branch development approach, with one branch per feature assign to only one developer at any time and I am interested to commit often in the repository.
Let's imagine I have a "User Story/Case" to code, example:
- User Story 125: Adding basic style to widget Image
"User Story" is divided in sub-tasks, these are particolarly technical, example:
- 01 Change CSS image tag.
- 02 Update decorator.
- 03 Update widget instance in Panel.
At the moment we use this format/style when committing:
STATUS - USER CASE - TASK
PROGRESS : User Story 125: Adding basic style to widget Image - 01 Change CSS image tag
- The first task for a specific User Story has been competed, but the User Story is not completed yet.
This is repeated for each completed sub-task.
When all sub-tasks are completed I use this format:
STATUS - USER CASE
- DONE : User Story 125: Adding basic style to widget Image
Same approach is used for Bugs.
When the branch is marge to main line we use:
DONE - USER CASE
Without mentioning the sub-tasks.
I would like have your opinion on:
- Do you see any CONS for this approach?
- How would you change/improve it accordingly with some good practice?
- For GIT, does make sense using "staging"on developer branch when committing sub-tasks?
Thanks in advance for your time on this.