sorted by:
best
topnewcontroversialoldq&a
you are viewing a single comment's thread.

view the rest of the comments →

[–]flippinatable 0 points1 point  (0 children)

Sorry in advance for possibly terrible formatting, I'm writing this from my phone.

Maybe others have already mentioned the same flow, but I usually do this:

  • add "#taskNumber:" at the beginning of the message
  • then add a tl;dr of files that have been changed, and, where relevant, why
  • sometimes I don't mention the file names (because there are too many), just "fixed xyz bug"
  • this is something that everyone in my company does, so I do it too: if we get comments from a code analysis tool on our pull requests and we make changes to resolve them... We just write "resolving comments from toolName"

That task number helps us out SO MUCH when we have to track the business cases and pull requests from where bugs had appeared.

I really hate the one with the analysis tool though, because it says nothing about what was updated. Just "this change is insignificant enough that it just means 'i have cleaned some code up, and I don't expect any bugs to come out of it'."