From: Christian Couder <firstname.lastname@example.org> To: Caleb Tillman <email@example.com> Cc: git <firstname.lastname@example.org> Subject: Re: [PATCH 1/1] Microproject - Use debug-friendly test_path_is_* functions. Date: Sat, 17 Oct 2020 09:19:05 +0200 Message-ID: <CAP8UFD2RS-sdaA8tJjqGW=L=_DM0QOZT-pg9D1oL8LEk7Cc84w@mail.gmail.com> (raw) In-Reply-To: <email@example.com> On Sat, Oct 17, 2020 at 8:05 AM Caleb Tillman <firstname.lastname@example.org> wrote: > > t0000-basic.sh - Replace an instance of test -f with test_path_is_file. This line seems redundant with the subject. We suggest that all the messages sent by Outreachy applicants or interns have "[Outreachy]" at the beginning of their subject. This way we can identify these emails more easily and prioritize them. Also using "[...]" ensures that "Outreachy" doesn't appear in the commits when the patches are applied. For Outreachy patches related to a test script, we suggest a subject like: [Outreachy][PATCH X/Y] tZZZZ: do something where X, Y and ZZZZ are numbers and tZZZZ is the identifier of the test script. So in this case the subject should be something like: [Outreachy][PATCH 1/1] t0000: replace an instance of test -f with test_path_is_file Note that there is no "Microproject" in the subject and that there is no uppercase letter used after "PATCH". The body of the message should explain the reason or the goal of the patch. Here the reason is that test_path_is_file provides an (hopefully helpful) error message when it fails, so it should make the reason for a test failure easier to diagnose. > Signed-off-by: Caleb Tillman <email@example.com> > --- Here, after the line with "---" and before the stats below, you can add comments that will not appear in the commit message when the patch will be applied. For example here you can say that the patch is your microproject. If you really want to make it more prominent, another option is to use [Outreachy-Microproject] in the subject instead of [Outreachy] but it makes the subject line longer for information that we are anyway not likely to miss. > t/t0000-basic.sh | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/t/t0000-basic.sh b/t/t0000-basic.sh > index 923281af93..eb99892a87 100755 > --- a/t/t0000-basic.sh > +++ b/t/t0000-basic.sh > @@ -1191,7 +1191,7 @@ test_expect_success 'writing this tree with --missing-ok' ' > test_expect_success 'git read-tree followed by write-tree should be idempotent' ' > rm -f .git/index && > git read-tree $tree && > - test -f .git/index && > + test_path_is_file .git/index && > newtree=$(git write-tree) && > test "$newtree" = "$tree" > ' This looks good to me. Thanks!
next prev parent reply other threads:[~2020-10-17 7:19 UTC|newest] Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top 2020-10-17 2:43 [Outreachy] [PATCH 0/1] Caleb Tillman 2020-10-17 2:43 ` [PATCH 1/1] Microproject - Use debug-friendly test_path_is_* functions Caleb Tillman 2020-10-17 7:19 ` Christian Couder [this message] 2020-10-17 6:43 ` [Outreachy] [PATCH 0/1] Christian Couder
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='CAP8UFD2RS-sdaA8tJjqGW=L=_DM0QOZT-pg9D1oL8LEk7Cc84w@mail.gmail.com' \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ /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
email@example.com list mirror (unofficial, one of many) This inbox may be cloned and mirrored by anyone: git clone --mirror https://public-inbox.org/git git clone --mirror http://ou63pmih66umazou.onion/git git clone --mirror http://czquwvybam4bgbro.onion/git git clone --mirror http://hjrcffqmbrq6wope.onion/git # If you have public-inbox 1.1+ installed, you may # initialize and index your mirror using the following commands: public-inbox-init -V1 git git/ https://public-inbox.org/git \ firstname.lastname@example.org public-inbox-index git Example config snippet for mirrors. Newsgroups are available over NNTP: nntp://news.public-inbox.org/inbox.comp.version-control.git nntp://ou63pmih66umazou.onion/inbox.comp.version-control.git nntp://czquwvybam4bgbro.onion/inbox.comp.version-control.git nntp://hjrcffqmbrq6wope.onion/inbox.comp.version-control.git nntp://news.gmane.io/gmane.comp.version-control.git note: .onion URLs require Tor: https://www.torproject.org/ code repositories for the project(s) associated with this inbox: https://80x24.org/mirrors/git.git AGPL code for this site: git clone https://public-inbox.org/public-inbox.git