| Message ID | 1117b5b1-fb9e-49b8-b1c3-47b985adce35@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | improve bugreports | expand |
On Sat, Mar 23, 2024, at 18:36, Rubén Justo wrote: > Include a mark in the questions we provide, to enhance the readability > of the reports we receive. > > Of course, the user has the flexibility to choose a different format or > rewrite the report entirely. However, including these marks in the > template may suggest that we value some structure in the message. > > Signed-off-by: Rubén Justo <rjusto@gmail.com> I like this. The questions and the answers not being differentiated makes things harder to read.
On 1/4/24 21:30, Kristoffer Haugsbakk wrote: > On Sat, Mar 23, 2024, at 18:36, Rubén Justo wrote: >> Include a mark in the questions we provide, to enhance the readability >> of the reports we receive. >> >> Of course, the user has the flexibility to choose a different format or >> rewrite the report entirely. However, including these marks in the >> template may suggest that we value some structure in the message. >> >> Signed-off-by: Rubén Justo <rjusto@gmail.com> > > I like this. The questions and the answers not being differentiated > makes things harder to read. Thanks for your response.
diff --git a/builtin/bugreport.c b/builtin/bugreport.c index 01b72163b9..d60ec483fa 100644 --- a/builtin/bugreport.c +++ b/builtin/bugreport.c @@ -76,13 +76,13 @@ static int get_bug_template(struct strbuf *template) "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\n" -"What did you expect to happen? (Expected behavior)\n" +"== What did you expect to happen? (Expected behavior)\n" "\n\n" -"What happened instead? (Actual behavior)\n" +"== What happened instead? (Actual behavior)\n" "\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\n" "Anything else you want to add:\n" "\n" diff --git a/t/t0091-bugreport.sh b/t/t0091-bugreport.sh index f9c1ff9cb2..9b3a2b0cd2 100755 --- a/t/t0091-bugreport.sh +++ b/t/t0091-bugreport.sh @@ -16,16 +16,16 @@ test_expect_success 'report contains wanted template (before first section)' ' 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:
Include a mark in the questions we provide, to enhance the readability of the reports we receive. Of course, the user has the flexibility to choose a different format or rewrite the report entirely. However, including these marks in the template may suggest that we value some structure in the message. Signed-off-by: Rubén Justo <rjusto@gmail.com> --- builtin/bugreport.c | 8 ++++---- t/t0091-bugreport.sh | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-)