From: Kaartic Sivaraam <kaartic.sivaraam@gmail.com>
To: "brian m. carlson" <sandals@crustytoothpaste.net>,
Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org
Subject: Re: [RFC] Contributor doc: more on the proposed log message
Date: Wed, 26 Jan 2022 16:37:27 +0530 [thread overview]
Message-ID: <700d8602-1efa-fe70-e9ff-5f5b7eb1a43c@gmail.com> (raw)
In-Reply-To: <Ye3JVEm77d7zMU5L@camp.crustytoothpaste.net>
On 24/01/22 3:02 am, brian m. carlson wrote:
> On 2022-01-23 at 20:37:18, Junio C Hamano wrote:
>> I have been thinking about making it more clear why we care about
>> the log message, and noticed that we have CodingGuidelines and
>> SubmittingPatches, both are specifically targetted for the
>> contributors of THIS project (not to users contributing to a project
>> that happens to use Git).
>>
>> I think the first thing to fix is that we have the "describe your
>> changes well" section in the latter, as if it is not part of the
>> code that is covered by CodingGuidelines. You formulate the thought
>> on how to explain/sell your changes to others, and you sift the text
>> you add to help fellow developers into the ones you leave in in-code
>> comments and in the proposed log message, while you code. I am
>> tempted to propose moving the part about proposed log message from
>> SubmittingPatches to CodingGuidelines for this reason.
>>
>> Independent of the above, here is a small update I would add to
>> clarify the project convention on the log message.
>>
>> Thoughts?
>
> I think this is a good idea, since it differs from the way people
> usually discuss things outside of literature, and it's very common for
> this to trip people up.
>
Precisely. I often get tripped up due to this whenever I write commit
messages in general. So, good to have this clarified through a guideline.
--
Sivaraam
next prev parent reply other threads:[~2022-01-26 11:07 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-23 20:37 [RFC] Contributor doc: more on the proposed log message Junio C Hamano
2022-01-23 21:32 ` brian m. carlson
2022-01-26 11:07 ` Kaartic Sivaraam [this message]
2022-01-26 23:42 ` [PATCH v2 0/3] contributor doc update around log messages Junio C Hamano
2022-01-26 23:42 ` [PATCH v2 1/3] SubmittingPatches: write problem statement in the log in the present tense Junio C Hamano
2022-01-26 23:42 ` [PATCH v2 2/3] CodingGuidelines: hint why we value clearly written log messages Junio C Hamano
2022-01-27 7:31 ` Eric Sunshine
2022-01-27 18:35 ` Junio C Hamano
2022-01-26 23:42 ` [PATCH v2 3/3] SubmittingPatches: explain why we care about " Junio C Hamano
2022-01-27 19:02 ` [PATCH v3 0/3] contributor doc update around " Junio C Hamano
2022-03-04 0:12 ` Emily Shaffer
2022-01-27 19:02 ` [PATCH v3 1/3] SubmittingPatches: write problem statement in the log in the present tense Junio C Hamano
2022-03-03 23:59 ` Emily Shaffer
2022-03-04 0:23 ` Junio C Hamano
2022-03-04 23:41 ` Emily Shaffer
2022-01-27 19:02 ` [PATCH v3 2/3] CodingGuidelines: hint why we value clearly written log messages Junio C Hamano
2022-03-04 0:07 ` Emily Shaffer
2022-03-04 0:27 ` Junio C Hamano
2022-04-14 6:51 ` Junio C Hamano
2022-04-14 14:04 ` Ævar Arnfjörð Bjarmason
2022-04-19 22:53 ` Emily Shaffer
2022-04-20 8:23 ` Junio C Hamano
2022-01-27 19:02 ` [PATCH v3 3/3] SubmittingPatches: explain why we care about " Junio C Hamano
2022-03-04 0:10 ` Emily Shaffer
2022-03-04 0:29 ` Junio C Hamano
2022-03-04 9:52 ` log messages > comments (was: [PATCH v3 3/3] SubmittingPatches: explain why we care about log messages) Ævar Arnfjörð Bjarmason
2022-03-04 19:41 ` log messages > comments Junio C Hamano
2022-03-04 21:30 ` Junio C Hamano
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=700d8602-1efa-fe70-e9ff-5f5b7eb1a43c@gmail.com \
--to=kaartic.sivaraam@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=sandals@crustytoothpaste.net \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).