All of lore.kernel.org
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: Guidlines for error messages
Date: Fri, 28 Jul 2017 20:57:38 -0700	[thread overview]
Message-ID: <xmqqa83nlwst.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <1501297078.2711.2.camel@gmail.com> (Kaartic Sivaraam's message of "Sat, 29 Jul 2017 08:27:58 +0530")

Kaartic Sivaraam <kaarticsivaraam91196@gmail.com> writes:

> 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.

      reply	other threads:[~2017-07-29  3:57 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-07-29  2:57 Guidlines for error messages Kaartic Sivaraam
2017-07-29  3:57 ` Junio C Hamano [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqa83nlwst.fsf@gitster.mtv.corp.google.com \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=kaarticsivaraam91196@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.