From: Kristoffer Haugsbakk <code@xxxxxxxxxxxxxxx>
Quoted line prefixes make it easier to distinguish between the questions
and the answers, both for the reporter and for the readers.
Based-on-patch-by: Felipe Contreras <felipe.contreras@xxxxxxxxx>
Signed-off-by: Kristoffer Haugsbakk <code@xxxxxxxxxxxxxxx>
---
Notes (series):
§ Changes in v2
• Update test which wasn’t there when v1 was made
• Rewrite commit message to one single sentence
• “use” in the subject is slightly more declarative than “add” (?)
builtin/bugreport.c | 18 +++++++++---------
t/t0091-bugreport.sh | 18 +++++++++---------
2 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/builtin/bugreport.c b/builtin/bugreport.c
index f78c3f2aed6..44be7eb4859 100644
--- a/builtin/bugreport.c
+++ b/builtin/bugreport.c
@@ -65,21 +65,21 @@ static const char * const bugreport_usage[] = {
static int get_bug_template(struct strbuf *template)
{
const char template_text[] = N_(
-"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"
-"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"
-"What did you expect to happen? (Expected behavior)\n"
+"> What did you expect to happen? (Expected behavior)\n"
"\n"
-"What happened instead? (Actual behavior)\n"
+"> What happened instead? (Actual behavior)\n"
"\n"
-"What's different between what you expected and what actually happened?\n"
+"> What's different between what you expected and what actually happened?\n"
"\n"
-"Anything else you want to add:\n"
+"> Anything else you want to add:\n"
"\n"
-"Please review the rest of the bug report below.\n"
-"You can delete any lines you don't wish to share.\n");
+"> Please review the rest of the bug report below.\n"
+"> You can delete any lines you don't wish to share.\n");
strbuf_addstr(template, _(template_text));
return 0;
diff --git a/t/t0091-bugreport.sh b/t/t0091-bugreport.sh
index e38ca7a9018..9d7008f3592 100755
--- a/t/t0091-bugreport.sh
+++ b/t/t0091-bugreport.sh
@@ -12,21 +12,21 @@ test_expect_success 'create a report' '
test_expect_success 'report contains wanted template (before first section)' '
sed -ne "/^\[/q;p" git-bugreport-format.txt >actual &&
cat >expect <<-\EOF &&
- Thank you for filling out a Git bug report!
- Please answer the following questions to help us understand your issue.
+ > Thank you for filling out a Git bug report!
+ > Please answer the following questions to help us understand your issue.
- What did you do before the bug happened? (Steps to reproduce your issue)
+ > What did you do before the bug happened? (Steps to reproduce your issue)
- What did you expect to happen? (Expected behavior)
+ > What did you expect to happen? (Expected behavior)
- What happened instead? (Actual behavior)
+ > What happened instead? (Actual behavior)
- What'\''s different between what you expected and what actually happened?
+ > What'\''s different between what you expected and what actually happened?
- Anything else you want to add:
+ > Anything else you want to add:
- Please review the rest of the bug report below.
- You can delete any lines you don'\''t wish to share.
+ > Please review the rest of the bug report below.
+ > You can delete any lines you don'\''t wish to share.
EOF
Range-diff against v1:
1: ef7a1cbd9d4 ! 1: 52a6177e706 bugreport: add quoted line prefixes
@@
## Metadata ##
-Author: Felipe Contreras <felipe.contreras@xxxxxxxxx>
+Author: Kristoffer Haugsbakk <code@xxxxxxxxxxxxxxx>
## Commit message ##
- bugreport: add quoted line prefixes
+ bugreport: use quoted line prefixes
- With quoted line prefixes it's easier to distinguish what are the
- standard questions, and what are the user responses.
+ Quoted line prefixes make it easier to distinguish between the questions
+ and the answers, both for the reporter and for the readers.
- Additionally it's easier for the reporter to visualize what has she
- responded.
+ Based-on-patch-by: Felipe Contreras <felipe.contreras@xxxxxxxxx>
+ Signed-off-by: Kristoffer Haugsbakk <code@xxxxxxxxxxxxxxx>
- Signed-off-by: Felipe Contreras <felipe.contreras@xxxxxxxxx>
+
+ ## Notes (series) ##
+ § Changes in v2
+
+ • Update test which wasn’t there when v1 was made
+ • Rewrite commit message to one single sentence
+ • “use” in the subject is slightly more declarative than “add” (?)
## builtin/bugreport.c ##
@@ builtin/bugreport.c: static const char * const bugreport_usage[] = {
@@ builtin/bugreport.c: static const char * const bugreport_usage[] = {
strbuf_addstr(template, _(template_text));
return 0;
+
+ ## t/t0091-bugreport.sh ##
+@@ t/t0091-bugreport.sh: test_expect_success 'create a report' '
+ test_expect_success 'report contains wanted template (before first section)' '
+ sed -ne "/^\[/q;p" git-bugreport-format.txt >actual &&
+ cat >expect <<-\EOF &&
+- Thank you for filling out a Git bug report!
+- Please answer the following questions to help us understand your issue.
++ > Thank you for filling out a Git bug report!
++ > Please answer the following questions to help us understand your issue.
+
+- What did you do before the bug happened? (Steps to reproduce your issue)
++ > What did you do before the bug happened? (Steps to reproduce your issue)
+
+- What did you expect to happen? (Expected behavior)
++ > What did you expect to happen? (Expected behavior)
+
+- What happened instead? (Actual behavior)
++ > What happened instead? (Actual behavior)
+
+- What'\''s different between what you expected and what actually happened?
++ > What'\''s different between what you expected and what actually happened?
+
+- Anything else you want to add:
++ > Anything else you want to add:
+
+- Please review the rest of the bug report below.
+- You can delete any lines you don'\''t wish to share.
++ > Please review the rest of the bug report below.
++ > You can delete any lines you don'\''t wish to share.
+
+
+ EOF
base-commit: 724518f3884d8707c5f51428ba98c115818229b8
--
2.50.1
