git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 1/2] bugreport: add a new line between questions

From
Rubén Justo <rjusto@gmail.com>
Date
Mar 23, 2024, 17:36 UTC
Message-ID
<bf1b2aef-2d8f-4b24-be2a-1a312f9f9f01@gmail.com>
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
Previous: Rubén JustoNext: Rubén Justo
Message 2 of 9 in “improve bugreports”
  1. 0/2 improve bugreportsRubén Justo, Mar 23, 2024
  2. 1/2 bugreport: add a new line between questionsRubén Justo, Mar 23, 2024
  3. 2/2 bugreport: add a mark to each proposed questionsRubén Justo, Mar 23, 2024
  4. Kristoffer HaugsbakkApr 1, 2024
  5. Rubén JustoApr 1, 2024
  6. Rubén JustoMar 31, 2024
  7. Eric SunshineApr 1, 2024
  8. Junio C HamanoApr 1, 2024
  9. Rubén JustoApr 1, 2024

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.