list mirror (unofficial, one of many)
 help / color / mirror / Atom feed
From: Christian Couder <>
To: Caleb Tillman <>
Cc: git <>
Subject: Re: [PATCH 1/1] Microproject - Use debug-friendly test_path_is_* functions.
Date: Sat, 17 Oct 2020 09:19:05 +0200
Message-ID: <> (raw)
In-Reply-To: <>

On Sat, Oct 17, 2020 at 8:05 AM Caleb Tillman <> wrote:
> - 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

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

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

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/ | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> diff --git a/t/ b/t/
> index 923281af93..eb99892a87 100755
> --- a/t/
> +++ b/t/
> @@ -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.


  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:

  List information:

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

  git send-email \
    --in-reply-to='' \ \ \ \

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link list mirror (unofficial, one of many)

This inbox may be cloned and mirrored by anyone:

	git clone --mirror
	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/ \
	public-inbox-index git

Example config snippet for mirrors.
Newsgroups are available over NNTP:
 note: .onion URLs require Tor:

code repositories for the project(s) associated with this inbox:

AGPL code for this site: git clone