3 ms·
Yes, it's not my preferred style either, but it's much better than 'fixes error' type thing, subject line only, that's so common. I like the form: Fix Arg
by OJFord 3y ago
Yes, it's not my preferred style either, but it's much better than 'fixes error' type thing, subject line only, that's so common.
I like the form:
Fix ArgumentError 'invalid byte sequence'
Non-ASCII whitespace characters cause [...]. This was apparent in [...] because [...].
This commit fixes the issue by removing the offending character; so the file is now solely ASCII characters.
Or that sort of thing. Subject tells me why, body tells me what the problem was and how it was fixed. (Who, when, where are already in the commit metadata! The diff shows a very literal 'what' too, the what/how in the body should offer context and explanation as required.)