git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Shuqi Liang <cheskaqiqi@gmail.com>
To: Eric Sunshine <sunshine@sunshineco.com>, git@vger.kernel.org
Subject: Re: [PATCH v5 3/3] t4113: put executable lines to test_expect_success
Date: Tue, 14 Feb 2023 21:40:33 -0500	[thread overview]
Message-ID: <CAMO4yUHx68jSe31gKon6_hXTiqufHnHAFkP32DXmWg7dtagAfQ@mail.gmail.com> (raw)
In-Reply-To: <CAPig+cTKCMwCQ2TxXyc1KquZmB0QWQAuuag52a1qmeYh6XPXYQ@mail.gmail.com>

On Tue, Feb 14, 2023 at 8:09 PM Eric Sunshine <sunshine@sunshineco.com> wrote:

> Although it's true that t/README explains why code should be placed
> inside tests, you can help readers out by simply explaining the reason
> here in the commit message. For instance, you might replace the above
> paragraph with:
>
>     Some old test scripts have setup code outside of tests. This
>     is problematic since any failures of the setup code will go
>     unnoticed. Therefore, move setup code into the tests themselves
>     so that failures are properly flagged.
>
Thanks, that really makes the change more clear for the readers. I learn a lot.

> Reviewers appreciate well-explained commit messages, but they also
> appreciate succinctness. Although it may not always be obvious how
> much to write in a commit message, you can assume that reviewers will
> understand obvious changes simply by reading the patch itself, thus
> you don't need to mention every little detail in the commit message.
> The important thing to mention in the commit message is the
> explanation of _why_ the change is being made, plus any changes which
> might not be obvious. In this case, all the changes are obvious, so,
> really, you can collapse this entire commit message to just the first
> paragraph.

Yeah, the commit looks very wordy. I'll make it more succinct.
>     test_write_lines a b c >file &&

> Same comment about simply using double quotes instead of
> single-quotes, however, this is also another really good place to use
> test_write_lines:
>
>     test_write_lines a b c >file &&

Thanks for the tips!

(Sorry for sending the V6 to you twice I send it by accident .)

-------------------------
Thanks
Shuqi

  reply	other threads:[~2023-02-15  2:40 UTC|newest]

Thread overview: 49+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-31 22:49 [GSoC][PATCH] t/t4113-apply-ending.sh: Modernize a test script Shuqi Liang
2023-02-01  2:21 ` Andrei Rybak
2023-02-02 17:20   ` cheska fran
2023-02-02 17:18 ` [PATCH v2 0/4] t4113: modernize test style Shuqi Liang
2023-02-02 17:18   ` [PATCH v2 1/4]t4113: replace backslash with single quote Shuqi Liang
2023-02-02 21:00     ` Junio C Hamano
2023-02-05 14:28       ` Shuqi Liang
2023-02-02 17:18   ` [PATCH v2 2/4] t4113:put second creation in own step Shuqi Liang
2023-02-02 17:18   ` [PATCH v2 3/4] t4113: use "<<-" instead of "<<" Shuqi Liang
2023-02-02 21:05     ` Junio C Hamano
2023-02-05 14:38       ` Shuqi Liang
2023-02-02 17:18   ` [PATCH v2 4/4] t4113: indent with tabs Shuqi Liang
2023-02-02 21:10     ` Junio C Hamano
2023-02-05 14:51       ` Shuqi Liang
2023-02-05 14:52   ` [PATCH v3 0/3] modernize style Shuqi Liang
2023-02-05 14:52     ` [PATCH v3 1/3]t4113: modernize a test script Shuqi Liang
2023-02-05 14:52     ` [PATCH v3 2/3] t4113: put executable lines to test_expect_success Shuqi Liang
2023-02-05 14:52     ` [PATCH v3 3/3] t4113: indent with space Shuqi Liang
2023-02-05 20:29       ` Eric Sunshine
2023-02-06 21:17         ` Shuqi Liang
2023-02-06 21:18     ` [PATCH v4 0/3] t4113: modernize style Shuqi Liang
2023-02-06 21:18       ` [PATCH v4 1/3] t4113: modernize test script Shuqi Liang
2023-02-06 21:18       ` [PATCH v4 2/3] t4113: indent with tab Shuqi Liang
2023-02-06 21:18       ` [PATCH v4 3/3] t4113: put executable lines to test_expect_success Shuqi Liang
2023-02-06 21:50         ` Ævar Arnfjörð Bjarmason
2023-02-06 22:44         ` Junio C Hamano
2023-02-06 23:42           ` Shuqi Liang
2023-02-07  8:05             ` Ævar Arnfjörð Bjarmason
2023-02-07 19:55               ` Shuqi Liang
2023-02-08  5:44               ` Shuqi Liang
2023-02-08  7:44                 ` Ævar Arnfjörð Bjarmason
2023-02-10 15:29                   ` Shuqi Liang
2023-02-15  0:34                   ` Eric Sunshine
2023-02-15  0:26               ` Eric Sunshine
2023-02-14 22:17           ` Shuqi Liang
2023-02-14 22:29             ` Junio C Hamano
2023-02-09 15:44       ` [PATCH v5 0/3] t4113: modernize style Shuqi Liang
2023-02-09 15:44         ` [PATCH v5 1/3] t4113: modernize test script Shuqi Liang
2023-02-09 15:44         ` [PATCH v5 2/3] t4113: indent with tab Shuqi Liang
2023-02-15  0:10           ` Eric Sunshine
2023-02-15  0:18             ` Shuqi Liang
2023-02-09 15:44         ` [PATCH v5 3/3] t4113: put executable lines to test_expect_success Shuqi Liang
2023-02-15  1:09           ` Eric Sunshine
2023-02-15  2:40             ` Shuqi Liang [this message]
2023-02-15  2:38         ` [PATCH v6 0/3] t4113: modernize style Shuqi Liang
2023-02-15  2:39         ` Shuqi Liang
2023-02-15  2:39           ` [PATCH v6 1/3] t4113: modernize test script Shuqi Liang
2023-02-15  2:39           ` [PATCH v6 2/3] t4113: indent with tab Shuqi Liang
2023-02-15  2:39           ` [PATCH v6 3/3] t4113: put executable lines to test_expect_success Shuqi Liang

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=CAMO4yUHx68jSe31gKon6_hXTiqufHnHAFkP32DXmWg7dtagAfQ@mail.gmail.com \
    --to=cheskaqiqi@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=sunshine@sunshineco.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.
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).