{"thread":{"id":"61188","subject":"[PATCH 0/2] improve bugreports","startedAt":"2024-03-23T17:32:42Z","lastAt":"2024-04-01T19:33:53Z","messageCount":9,"participants":["Rubén Justo","Eric Sunshine","Junio C Hamano","Kristoffer Haugsbakk"],"isPatch":true,"patchVersion":1,"patchTotal":2},"messages":[{"id":"491303","messageId":"35de2d76-a03e-4a36-9bb7-6b6ffa4ea123@gmail.com","threadId":"61188","inReplyTo":null,"subject":"[PATCH 0/2] improve bugreports","fromName":"Rubén Justo","fromEmail":"rjusto@gmail.com","sentAt":"2024-03-23T17:32:35Z","receivedAt":"2024-03-23T17:32:42Z","isPatch":true,"sender":{"key":"rjusto@gmail.com","avatar":"https://avatars.githubusercontent.com/u/5685487?v=4"},"body":"Let's try to improve the readability of the bug reports we receive.\n\nThe first message should not receive many comments. The second one\nmight. I'm open to suggestions.\n\nThanks.\n\nRubén Justo (2):\n bugreport: add a new line between questions\n bugreport: add a mark to each proposed questions\n\n builtin/bugreport.c | 16 ++++++++--------\n t/t0091-bugreport.sh | 12 ++++++++----\n 2 files changed, 16 insertions(+), 12 deletions(-)\n\n-- \n2.44.0.494.g7a0daf3e0d\n"},{"id":"491304","messageId":"bf1b2aef-2d8f-4b24-be2a-1a312f9f9f01@gmail.com","threadId":"61188","inReplyTo":"35de2d76-a03e-4a36-9bb7-6b6ffa4ea123@gmail.com","subject":"[PATCH 1/2] bugreport: add a new line between questions","fromName":"Rubén Justo","fromEmail":"rjusto@gmail.com","sentAt":"2024-03-23T17:36:02Z","receivedAt":"2024-03-23T17:36:10Z","isPatch":true,"sender":{"key":"rjusto@gmail.com","avatar":"https://avatars.githubusercontent.com/u/5685487?v=4"},"body":"Occasionally, we receive reports where the user have filled in the blank\nline we provide between each proposed question, without leaving any\nspace between the answer and the next question. This makes reading the\nreport uncomfortable.\n\nPerhaps we can suggest to the user to include a blank line if we\nduplicate the empty line we provide. Let's do that and see what\nhappens.\n\nSigned-off-by: Rubén Justo \n---\n builtin/bugreport.c | 8 ++++----\n t/t0091-bugreport.sh | 4 ++++\n 2 files changed, 8 insertions(+), 4 deletions(-)\n\ndiff --git a/builtin/bugreport.c b/builtin/bugreport.c\nindex 25f860a0d9..01b72163b9 100644\n--- a/builtin/bugreport.c\n+++ b/builtin/bugreport.c\n@@ -77,13 +77,13 @@ static int get_bug_template(struct strbuf *template)\n \"Please answer the following questions to help us understand your issue.\\n\"\n \"\\n\"\n \"What did you do before the bug happened? (Steps to reproduce your issue)\\n\"\n-\"\\n\"\n+\"\\n\\n\"\n \"What did you expect to happen? (Expected behavior)\\n\"\n-\"\\n\"\n+\"\\n\\n\"\n \"What happened instead? (Actual behavior)\\n\"\n-\"\\n\"\n+\"\\n\\n\"\n \"What's different between what you expected and what actually happened?\\n\"\n-\"\\n\"\n+\"\\n\\n\"\n \"Anything else you want to add:\\n\"\n \"\\n\"\n \"Please review the rest of the bug report below.\\n\"\ndiff --git a/t/t0091-bugreport.sh b/t/t0091-bugreport.sh\nindex fca39048fe..f9c1ff9cb2 100755\n--- a/t/t0091-bugreport.sh\n+++ b/t/t0091-bugreport.sh\n@@ -18,12 +18,16 @@ test_expect_success 'report contains wanted template (before first section)' '\n \n \tWhat did you do before the bug happened? (Steps to reproduce your issue)\n \n+\n \tWhat did you expect to happen? (Expected behavior)\n \n+\n \tWhat happened instead? (Actual behavior)\n \n+\n \tWhat'\\''s different between what you expected and what actually happened?\n \n+\n \tAnything else you want to add:\n \n \tPlease review the rest of the bug report below.\n-- \n2.44.0.494.g7a0daf3e0d\n"},{"id":"491306","messageId":"1117b5b1-fb9e-49b8-b1c3-47b985adce35@gmail.com","threadId":"61188","inReplyTo":"35de2d76-a03e-4a36-9bb7-6b6ffa4ea123@gmail.com","subject":"[PATCH 2/2] bugreport: add a mark to each proposed questions","fromName":"Rubén Justo","fromEmail":"rjusto@gmail.com","sentAt":"2024-03-23T17:36:51Z","receivedAt":"2024-03-23T17:36:58Z","isPatch":true,"sender":{"key":"rjusto@gmail.com","avatar":"https://avatars.githubusercontent.com/u/5685487?v=4"},"body":"Include a mark in the questions we provide, to enhance the readability\nof the reports we receive.\n\nOf course, the user has the flexibility to choose a different format or\nrewrite the report entirely. However, including these marks in the\ntemplate may suggest that we value some structure in the message.\n\nSigned-off-by: Rubén Justo \n---\n builtin/bugreport.c | 8 ++++----\n t/t0091-bugreport.sh | 8 ++++----\n 2 files changed, 8 insertions(+), 8 deletions(-)\n\ndiff --git a/builtin/bugreport.c b/builtin/bugreport.c\nindex 01b72163b9..d60ec483fa 100644\n--- a/builtin/bugreport.c\n+++ b/builtin/bugreport.c\n@@ -76,13 +76,13 @@ static int get_bug_template(struct strbuf *template)\n \"Thank you for filling out a Git bug report!\\n\"\n \"Please answer the following questions to help us understand your issue.\\n\"\n \"\\n\"\n-\"What did you do before the bug happened? (Steps to reproduce your issue)\\n\"\n+\"== What did you do before the bug happened? (Steps to reproduce your issue)\\n\"\n \"\\n\\n\"\n-\"What did you expect to happen? (Expected behavior)\\n\"\n+\"== What did you expect to happen? (Expected behavior)\\n\"\n \"\\n\\n\"\n-\"What happened instead? (Actual behavior)\\n\"\n+\"== What happened instead? (Actual behavior)\\n\"\n \"\\n\\n\"\n-\"What's different between what you expected and what actually happened?\\n\"\n+\"== What's different between what you expected and what actually happened?\\n\"\n \"\\n\\n\"\n \"Anything else you want to add:\\n\"\n \"\\n\"\ndiff --git a/t/t0091-bugreport.sh b/t/t0091-bugreport.sh\nindex f9c1ff9cb2..9b3a2b0cd2 100755\n--- a/t/t0091-bugreport.sh\n+++ b/t/t0091-bugreport.sh\n@@ -16,16 +16,16 @@ test_expect_success 'report contains wanted template (before first section)' '\n \tThank you for filling out a Git bug report!\n \tPlease answer the following questions to help us understand your issue.\n \n-\tWhat did you do before the bug happened? (Steps to reproduce your issue)\n+\t== What did you do before the bug happened? (Steps to reproduce your issue)\n \n \n-\tWhat did you expect to happen? (Expected behavior)\n+\t== What did you expect to happen? (Expected behavior)\n \n \n-\tWhat happened instead? (Actual behavior)\n+\t== What happened instead? (Actual behavior)\n \n \n-\tWhat'\\''s different between what you expected and what actually happened?\n+\t== What'\\''s different between what you expected and what actually happened?\n \n \n \tAnything else you want to add:\n-- \n2.44.0.494.g7a0daf3e0d\n"},{"id":"491919","messageId":"4f179986-6aca-405a-a122-d0dc058c60d8@gmail.com","threadId":"61188","inReplyTo":"35de2d76-a03e-4a36-9bb7-6b6ffa4ea123@gmail.com","subject":"Re: [PATCH 0/2] improve bugreports","fromName":"Rubén Justo","fromEmail":"rjusto@gmail.com","sentAt":"2024-03-31T07:04:06Z","receivedAt":"2024-03-31T07:04:30Z","isPatch":true,"sender":{"key":"rjusto@gmail.com","avatar":"https://avatars.githubusercontent.com/u/5685487?v=4"},"body":"On Sat, Mar 23, 2024 at 06:32:35PM +0100, Rubén Justo wrote:\n> Let's try to improve the readability of the bug reports we receive.\n> \n> The first message should not receive many comments. The second one\n> might. I'm open to suggestions.\n> \n> Thanks.\n> \n> Rubén Justo (2):\n> bugreport: add a new line between questions\n> bugreport: add a mark to each proposed questions\n> \n> builtin/bugreport.c | 16 ++++++++--------\n> t/t0091-bugreport.sh | 12 ++++++++----\n> 2 files changed, 16 insertions(+), 12 deletions(-)\n> \n> -- \n> 2.44.0.494.g7a0daf3e0d\n\nThis series received no response. One option may be because it went\nunnoticed, another because it may not add value. I'm going to give it\nanother try and I'll quietly :-) take silence as confirmation of the\nsecond option. \n\nI'll try to increase the chances of getting a \"looks good\" by CC'ing\nsome folks involved in the bugreport tool.\n\nThanks.\n"},{"id":"491940","messageId":"CAPig+cRFqddMqTxCENnknv3Agcq3_bxGmB1sQTmJNb=xNYg1aw@mail.gmail.com","threadId":"61188","inReplyTo":"4f179986-6aca-405a-a122-d0dc058c60d8@gmail.com","subject":"Re: [PATCH 0/2] improve bugreports","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2024-04-01T03:09:02Z","receivedAt":"2024-04-01T03:09:16Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Sun, Mar 31, 2024 at 3:04 AM Rubén Justo wrote:\n> On Sat, Mar 23, 2024 at 06:32:35PM +0100, Rubén Justo wrote:\n> > Let's try to improve the readability of the bug reports we receive.\n>\n> This series received no response. One option may be because it went\n> unnoticed, another because it may not add value. I'm going to give it\n> another try and I'll quietly :-) take silence as confirmation of the\n> second option.\n>\n> I'll try to increase the chances of getting a \"looks good\" by CC'ing\n> some folks involved in the bugreport tool.\n\nFor what it's worth, when I read the cover letter of this series, I\nthought it was going to clean up the list of questions to eliminate\nredundancy. In particular, of the three questions:\n\n What did you expect to happen?\n What happened instead?\n What's different between what you expected\n and what actually happened?\n\nthe final one seems to repeat what the first two ask, and it is common\nwhen answering the third question for people to simply repeat what was\nsaid in response to an earlier question.\n"},{"id":"491954","messageId":"xmqq5xx1e8hx.fsf@gitster.g","threadId":"61188","inReplyTo":"CAPig+cRFqddMqTxCENnknv3Agcq3_bxGmB1sQTmJNb=xNYg1aw@mail.gmail.com","subject":"Re: [PATCH 0/2] improve bugreports","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2024-04-01T09:29:30Z","receivedAt":"2024-04-01T09:29:33Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Eric Sunshine writes:\n\n> redundancy. In particular, of the three questions:\n>\n> What did you expect to happen?\n> What happened instead?\n> What's different between what you expected\n> and what actually happened?\n>\n> the final one seems to repeat what the first two ask, and it is common\n> when answering the third question for people to simply repeat what was\n> said in response to an earlier question.\n\nThe third one may need to be rephrased, but I think it should still\nbe there. The intent is to make the reporter realize how unhelpful\ntheir answers are when they answer the first two questions with\n\n - I expected it to work correctly\n - It did not work correctly\n\nThey hopefully would realize that \"work correctly\" needs to be\nelaborated in order to answer the third question in a useful way.\nIf the first two questions have been answered in a usable way, the\nthird one is often redundant.\n"},{"id":"491976","messageId":"5acafee5-dd65-49f1-bc2d-f959ed4bc9e1@gmail.com","threadId":"61188","inReplyTo":"CAPig+cRFqddMqTxCENnknv3Agcq3_bxGmB1sQTmJNb=xNYg1aw@mail.gmail.com","subject":"Re: [PATCH 0/2] improve bugreports","fromName":"Rubén Justo","fromEmail":"rjusto@gmail.com","sentAt":"2024-04-01T19:27:31Z","receivedAt":"2024-04-01T19:27:39Z","isPatch":true,"sender":{"key":"rjusto@gmail.com","avatar":"https://avatars.githubusercontent.com/u/5685487?v=4"},"body":"On Sun, Mar 31, 2024 at 11:09:02PM -0400, Eric Sunshine wrote:\n> On Sun, Mar 31, 2024 at 3:04 AM Rubén Justo wrote:\n> > On Sat, Mar 23, 2024 at 06:32:35PM +0100, Rubén Justo wrote:\n> > > Let's try to improve the readability of the bug reports we receive.\n> >\n> > This series received no response. One option may be because it went\n> > unnoticed, another because it may not add value. I'm going to give it\n> > another try and I'll quietly :-) take silence as confirmation of the\n> > second option.\n> >\n> > I'll try to increase the chances of getting a \"looks good\" by CC'ing\n> > some folks involved in the bugreport tool.\n> \n> For what it's worth, when I read the cover letter of this series, I\n> thought it was going to clean up the list of questions to eliminate\n> redundancy. In particular, of the three questions:\n> \n> What did you expect to happen?\n> What happened instead?\n> What's different between what you expected\n> and what actually happened?\n> \n> the final one seems to repeat what the first two ask, and it is common\n> when answering the third question for people to simply repeat what was\n> said in response to an earlier question.\n\nCertainly, a diagnostic questionnaire can always be improved.\nUnfortunately I do not have a better wording to offer here to reduce\nthat sense of repetition.\n\nThanks for your response.\n"},{"id":"491977","messageId":"bb4cd824-c9ca-4adb-8339-885273aed9bc@app.fastmail.com","threadId":"61188","inReplyTo":"1117b5b1-fb9e-49b8-b1c3-47b985adce35@gmail.com","subject":"Re: [PATCH 2/2] bugreport: add a mark to each proposed questions","fromName":"Kristoffer Haugsbakk","fromEmail":"code@khaugsbakk.name","sentAt":"2024-04-01T19:30:51Z","receivedAt":"2024-04-01T19:31:13Z","isPatch":true,"sender":{"key":"code@khaugsbakk.name","avatar":"https://avatars.githubusercontent.com/u/2229597?v=4"},"body":"On Sat, Mar 23, 2024, at 18:36, Rubén Justo wrote:\n> Include a mark in the questions we provide, to enhance the readability\n> of the reports we receive.\n>\n> Of course, the user has the flexibility to choose a different format or\n> rewrite the report entirely. However, including these marks in the\n> template may suggest that we value some structure in the message.\n>\n> Signed-off-by: Rubén Justo \n\nI like this. The questions and the answers not being differentiated\nmakes things harder to read.\n"},{"id":"491978","messageId":"85769d41-e0b8-4f68-b709-511e97c82c37@gmail.com","threadId":"61188","inReplyTo":"bb4cd824-c9ca-4adb-8339-885273aed9bc@app.fastmail.com","subject":"Re: [PATCH 2/2] bugreport: add a mark to each proposed questions","fromName":"Rubén Justo","fromEmail":"rjusto@gmail.com","sentAt":"2024-04-01T19:33:47Z","receivedAt":"2024-04-01T19:33:53Z","isPatch":true,"sender":{"key":"rjusto@gmail.com","avatar":"https://avatars.githubusercontent.com/u/5685487?v=4"},"body":"On 1/4/24 21:30, Kristoffer Haugsbakk wrote:\n> On Sat, Mar 23, 2024, at 18:36, Rubén Justo wrote:\n>> Include a mark in the questions we provide, to enhance the readability\n>> of the reports we receive.\n>>\n>> Of course, the user has the flexibility to choose a different format or\n>> rewrite the report entirely. However, including these marks in the\n>> template may suggest that we value some structure in the message.\n>>\n>> Signed-off-by: Rubén Justo \n> \n> I like this. The questions and the answers not being differentiated\n> makes things harder to read.\n\nThanks for your response.\n"}]}