Re: Guidlines for error messages
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Jul 29, 2017, 03:57 UTC
- Message-ID
- <xmqqa83nlwst.fsf@gitster.mtv.corp.google.com>
- In-Reply-To
- <1501297078.2711.2.camel@gmail.com>
Kaartic Sivaraam <kaarticsivaraam91196@gmail.com> writes:
Show 6 quoted lines
> On reading the CodingGuidelines, I saw a section that specifies rules > about the structure ... > ... > That makes me wonder, has the guideline changed ? > Is this something that must be fixed ? > Am I missing something ?
This applies not just to the message format but with ANY guideline we have around here.
As we did not have perfect foresight when we started the project, the guidelines grew out of the best practice we learned over time. We try to catch violations for new code during the review process, so that we won't add violators, but we do _not_ actively hunt for existing violators and change them _only_ to fix them, which is unneeded code churn. Instead, over time as people notice, most often while doing a real work in the vicinity of the code that has violations, we fix them as preparatory clean-up patches before the real work happens.