My Favourite Git Commit

I say yes. I like to keep information about the code as close to the code as possible. Issue trackers come and go, and even if you keep the same issue tracker around, how are you going to relate the change in the code to the particular issue down the road?

FWIW, I also prefer READMEs to Wikis.

Re: My Favourite Git Commit

#6

Post by Sharparam » Fri, Oct 18, 2019, 9:59 AM UTC

Chris2048 wrote: post #2

Should this go into a commit message, instead of an issue/ticket?

Since this is describing the commit and what was done and why, the commit seems like a better place.

In tools like GitHub, if you make a PR with this commit, it will also automatically put the text in the PR description.

I would much prefer this at work over what I usually see with inconsistent commit message styles and not explaining properly what was done, and not following the recommended max length per line.

Re: My Favourite Git Commit

#7

Post by shakna » Fri, Oct 18, 2019, 9:59 AM UTC

Chris2048 wrote: post #2

Should this go into a commit message, instead of an issue/ticket?

The commit message still logs in the usual way, but it carries the whole set of information with it, in a way that a centralised ticket system doesn't.

When a developer is looking at logs for solving some problem, they can easily review the rationale for changes.

I'd much prefer the log explaining everything, rather than having to look to a ticket that may no longer exist.

Re: My Favourite Git Commit

#8

Post by d--b » Fri, Oct 18, 2019, 10:00 AM UTC

Yeah but because git is a command line tool, it doesn’t really encourage you to do this in the first place...

The title of the commit was enough for me. I wouldn’t have read the content anyways

Re: My Favourite Git Commit

#9

Post by torgard » Fri, Oct 18, 2019, 10:00 AM UTC

Chris2048 wrote: post #2

Should this go into a commit message, instead of an issue/ticket?

If you put it in a pull request, that'll just put it in the merge commit instead.

I'd prefer it being on the commit itself.

Re: My Favourite Git Commit

#10

Post by hleszek » Fri, Oct 18, 2019, 10:00 AM UTC

To avoid those kind of issues, non-ascii characters are forbidden in our code base. They are automatically verified in a pre-commit git hook.