git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Rubén Justo" <rjusto@gmail.com>
To: Git List <git@vger.kernel.org>
Subject: [PATCH 1/2] bugreport: add a new line between questions
Date: Sat, 23 Mar 2024 18:36:02 +0100	[thread overview]
Message-ID: <bf1b2aef-2d8f-4b24-be2a-1a312f9f9f01@gmail.com> (raw)
In-Reply-To: <35de2d76-a03e-4a36-9bb7-6b6ffa4ea123@gmail.com>

Occasionally, we receive reports where the user have filled in the blank
line we provide between each proposed question, without leaving any
space between the answer and the next question.  This makes reading the
report uncomfortable.

Perhaps we can suggest to the user to include a blank line if we
duplicate the empty line we provide.  Let's do that and see what
happens.

Signed-off-by: Rubén Justo <rjusto@gmail.com>
---
 builtin/bugreport.c  | 8 ++++----
 t/t0091-bugreport.sh | 4 ++++
 2 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/builtin/bugreport.c b/builtin/bugreport.c
index 25f860a0d9..01b72163b9 100644
--- a/builtin/bugreport.c
+++ b/builtin/bugreport.c
@@ -77,13 +77,13 @@ static int get_bug_template(struct strbuf *template)
 "Please answer the following questions to help us understand your issue.\n"
 "\n"
 "What did you do before the bug happened? (Steps to reproduce your issue)\n"
-"\n"
+"\n\n"
 "What did you expect to happen? (Expected behavior)\n"
-"\n"
+"\n\n"
 "What happened instead? (Actual behavior)\n"
-"\n"
+"\n\n"
 "What's different between what you expected and what actually happened?\n"
-"\n"
+"\n\n"
 "Anything else you want to add:\n"
 "\n"
 "Please review the rest of the bug report below.\n"
diff --git a/t/t0091-bugreport.sh b/t/t0091-bugreport.sh
index fca39048fe..f9c1ff9cb2 100755
--- a/t/t0091-bugreport.sh
+++ b/t/t0091-bugreport.sh
@@ -18,12 +18,16 @@ test_expect_success 'report contains wanted template (before first section)' '
 
 	What did you do before the bug happened? (Steps to reproduce your issue)
 
+
 	What did you expect to happen? (Expected behavior)
 
+
 	What happened instead? (Actual behavior)
 
+
 	What'\''s different between what you expected and what actually happened?
 
+
 	Anything else you want to add:
 
 	Please review the rest of the bug report below.
-- 
2.44.0.494.g7a0daf3e0d


  reply	other threads:[~2024-03-23 17:36 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-23 17:32 [PATCH 0/2] improve bugreports Rubén Justo
2024-03-23 17:36 ` Rubén Justo [this message]
2024-03-23 17:36 ` [PATCH 2/2] bugreport: add a mark to each proposed questions Rubén Justo
2024-04-01 19:30   ` Kristoffer Haugsbakk
2024-04-01 19:33     ` Rubén Justo
2024-03-31  7:04 ` [PATCH 0/2] improve bugreports Rubén Justo
2024-04-01  3:09   ` Eric Sunshine
2024-04-01  9:29     ` Junio C Hamano
2024-04-01 19:27     ` Rubén Justo

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=bf1b2aef-2d8f-4b24-be2a-1a312f9f9f01@gmail.com \
    --to=rjusto@gmail.com \
    --cc=git@vger.kernel.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
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).