Re: Review your squash-merge message to remove duplicate text

2020-06-25 Thread David Smiley
Ilan, your checkout is not up to date then.  Here they are on GitHub:
https://github.com/apache/lucene-solr/commit/57a892f896f543913d6b22a81577f69184cd94b6
https://github.com/apache/lucene-solr/commit/25428013fb0ed8f8fdbebdef3f1d65dea77129c2
https://github.com/apache/lucene-solr/commit/26075fc1dc06766a9d2af8bd5dd14243c0463a6b

That means that for most squash and merge the dialog box should be left
> empty, as the PR title should already have the relevant info (Jira ID +
> short description), right? And when the PR title does not contain this
> info, we should edit it prior to commit.
>

*If* you manage to have a nice 1-liner title that you think is sufficient,
then it's fine.  Perhaps it's something simple/obvious.  But most commits I
do and see of others have more helpful details.  As a reader of other
people's commits, I *really* appreciate that.  Even if I could go to the
JIRA issue for other details, it's helpful to see them in the commit
message.

~ David


On Thu, Jun 25, 2020 at 1:36 AM Ilan Ginzburg  wrote:

> I could only git show the last id in your email David.
>
> That means that for most squash and merge the dialog box should be left
> empty, as the PR title should already have the relevant info (Jira ID +
> short description), right? And when the PR title does not contain this
> info, we should edit it prior to commit.
> Making sure I understand you correctly.
>
> Ilan
>
> On Thu, Jun 25, 2020 at 6:00 AM David Smiley  wrote:
>
>> Fellow committers,
>>
>> When hitting that squash-merge button in GitHub UI, the first line of the
>> dialog for the commit message is set apart from the rest of the message.
>> Then it's followed by a multi-line text box for the remaining lines.  The
>> beginning line of the rest of the message is often duplicated or
>> effectively redundant with that first title line.  Please edit your message
>> so that the redundancy is gone because the whole thing winds up in the
>> commit message, which is ultimately rather untidy/unclean.
>>
>> Most commits are fine.  Here are some examples of the problem I speak of
>> by 3 separate individuals:
>>
>> 57a892f896f543913d6b22a81577f69184cd94b6 
>> 25428013fb0ed8f8fdbebdef3f1d65dea77129c2
>> 26075fc1dc06766a9d2af8bd5dd14243c0463a6b
>>
>> Thanks,
>>
>> ~ David Smiley
>> Apache Lucene/Solr Search Developer
>> http://www.linkedin.com/in/davidwsmiley
>>
>


Re: Review your squash-merge message to remove duplicate text

2020-06-24 Thread Ilan Ginzburg
I could only git show the last id in your email David.

That means that for most squash and merge the dialog box should be left
empty, as the PR title should already have the relevant info (Jira ID +
short description), right? And when the PR title does not contain this
info, we should edit it prior to commit.
Making sure I understand you correctly.

Ilan

On Thu, Jun 25, 2020 at 6:00 AM David Smiley  wrote:

> Fellow committers,
>
> When hitting that squash-merge button in GitHub UI, the first line of the
> dialog for the commit message is set apart from the rest of the message.
> Then it's followed by a multi-line text box for the remaining lines.  The
> beginning line of the rest of the message is often duplicated or
> effectively redundant with that first title line.  Please edit your message
> so that the redundancy is gone because the whole thing winds up in the
> commit message, which is ultimately rather untidy/unclean.
>
> Most commits are fine.  Here are some examples of the problem I speak of
> by 3 separate individuals:
>
> 57a892f896f543913d6b22a81577f69184cd94b6 
> 25428013fb0ed8f8fdbebdef3f1d65dea77129c2
> 26075fc1dc06766a9d2af8bd5dd14243c0463a6b
>
> Thanks,
>
> ~ David Smiley
> Apache Lucene/Solr Search Developer
> http://www.linkedin.com/in/davidwsmiley
>


Review your squash-merge message to remove duplicate text

2020-06-24 Thread David Smiley
Fellow committers,

When hitting that squash-merge button in GitHub UI, the first line of the
dialog for the commit message is set apart from the rest of the message.
Then it's followed by a multi-line text box for the remaining lines.  The
beginning line of the rest of the message is often duplicated or
effectively redundant with that first title line.  Please edit your message
so that the redundancy is gone because the whole thing winds up in the
commit message, which is ultimately rather untidy/unclean.

Most commits are fine.  Here are some examples of the problem I speak of by
3 separate individuals:
57a892f896f543913d6b22a81577f69184cd94b6
25428013fb0ed8f8fdbebdef3f1d65dea77129c2
26075fc1dc06766a9d2af8bd5dd14243c0463a6b

Thanks,

~ David Smiley
Apache Lucene/Solr Search Developer
http://www.linkedin.com/in/davidwsmiley