T
T
TCloud2021-07-23 05:07:05
git
TCloud, 2021-07-23 05:07:05

What's the point of writing a comment on a commit?

Before reading the question, read this article or its translation in order to understand what it is about.

Recently, my colleagues and I switched to a tracker to organize work. Accordingly, the question arose "how to link tasks in the tracker with changes in the repository? How to arrange branches and commits?"
In the course of the discussion, we decided that it makes sense to name the branches according to the task code from the tracker, for example, PRJ-3and similarly commits PRJ-3. There was a proposal to write commits in this format PRJ-3 <краткий коммент к коммиту>, but they did not see the point in the comments to the commit (a comment for the sake of a comment).

When do you think it makes sense to write a comment to a commit and is there any at all?

Answer the question

In order to leave comments, you need to log in

1 answer(s)
D
DevMan, 2021-07-23
@OTCloud

a meaningful description of a commit is a must-have.
prj-3 is shit, not a commit description.
in fact, there are a lot of piano moments here. but the description of the commit should be informative. at least the final one, which will go into the release branch.

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question