How to write comments for version control (git, bitbucket)?

Question

git

Tell me how to write commits for the project.
My task is to make layout and transfer it to the programmer. What points and changes are better to comment on: adding plugins, refactoring, adding pages. What else?
Who had experience in version control of layout, share your experience)

Answer 1

I always do this:
- I create a task for a feature / bug / refactoring, in which I describe the task;
- I create a branch, I do everything that is necessary;
- I accompany each commit with the following refs #< task_id >: <a brief description of the changes made> (if a commit suddenly raised a hand to touch on several tasks, then refs #< task_id >, #< task_id >, but it's better not to do that);
- when a feature is ready, I merge it into the main branch with the commit history saved;
- I make changes to the task tracker - I describe the solution (what has changed, what I did, how I did it), close the task.
This is what I do even when I work alone. Then it is easy to view the history by the task number, find out to which task these changes belonged, and the history is not overloaded with long stories "how I spent the summer." Well, a bonus: task trackers are able to collect information formed in some standardized form.

Answer 2

This is an eternal problem :)
xkcd
And by and large, the programmer is not happy with what you typeset there, unless you make changes to the "dynamic" part and the programmer will need to make changes to some partial, but he obviously must learn this not from your comments in GIT.

Answer 3

Well, write so that you can understand what you did in a week.