From: Junio C Hamano <gitster@pobox.com>
To: kristofferhaugsbakk@fastmail.com
Cc: git@vger.kernel.org, Kristoffer Haugsbakk <code@khaugsbakk.name>,
Emily Shaffer <nasamuffin@google.com>
Subject: Re: [PATCH v2] bugreport: use quoted line prefixes
Date: Fri, 15 Aug 2025 09:18:44 -0700 [thread overview]
Message-ID: <xmqq5xeosgm3.fsf@gitster.g> (raw)
In-Reply-To: <52a6177e706d8653251c61bc660f10b703ea6a9e.1755256099.git.code@khaugsbakk.name> (kristofferhaugsbakk@fastmail.com's message of "Fri, 15 Aug 2025 13:10:15 +0200")
kristofferhaugsbakk@fastmail.com writes:
> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>
> Quoted line prefixes make it easier to distinguish between the questions
> and the answers, both for the reporter and for the readers.
This may improve things a bit, but the #1 thing that made the
reports most hard to read for me, while reading bugreport output
posted here over time, is lack of a blank line between each question
and its answer (and the tail end of an answer and the beginning of
the next question).
I wonder if there are things we can do to encourage reporters to
leave blank lines around what they write?
> -"Thank you for filling out a Git bug report!\n"
> -"Please answer the following questions to help us understand your issue.\n"
> +"> Thank you for filling out a Git bug report!\n"
> +"> Please answer the following questions to help us understand your issue.\n"
> "\n"
I do not see a need to quote the above. Nobody will write in this
space between the above introductory text and the first question
below.
> -"What did you do before the bug happened? (Steps to reproduce your issue)\n"
> +"> What did you do before the bug happened? (Steps to reproduce your issue)\n"
> "\n"
Here is one blank line between this question and the next question.
If the reporter typed on that blank line, we end up with an
uninterrupted sequence of questions and answers.
I wonder if it helps if we did:
- Give more blank lines upfront, like three lines, making it
> We ask you a question here...
> We ask you another question here...
- Give a stronger prompt to guide them where to write their answer.
Q1. We ask you a question here...
A1.
Q2. We ask you another question here...
I suspec that the latter might result in what we want, without
annoying the repoter too much. We could also do
> We ask you a question here ...
(please write your answer here)
> We ask you another question here ...
but that would make them remove that place-holding prompt, which
would be annoying, and at the same time, tempt them to remove the
blank lines around it. The fewer things we make them remove, the
better chance we have to achieve what we want, I think.
Thanks.
next prev parent reply other threads:[~2025-08-15 16:18 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-23 17:59 [PATCH] bugreport: add quoted line prefixes Felipe Contreras
2025-08-15 11:10 ` [PATCH v2] bugreport: use " kristofferhaugsbakk
2025-08-15 16:18 ` Junio C Hamano [this message]
2025-08-23 8:23 ` Kristoffer Haugsbakk
2025-08-22 12:49 ` [PATCH v3] bugreport: use quoted line prefixes & more blank lines kristofferhaugsbakk
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqq5xeosgm3.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=code@khaugsbakk.name \
--cc=git@vger.kernel.org \
--cc=kristofferhaugsbakk@fastmail.com \
--cc=nasamuffin@google.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.
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 NNTP newsgroup(s).