From patchwork Sat Mar 23 17:36:02 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Rub=C3=A9n_Justo?= X-Patchwork-Id: 13600720 Received: from mail-wm1-f48.google.com (mail-wm1-f48.google.com [209.85.128.48]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 5FE6E3A1A3 for ; Sat, 23 Mar 2024 17:36:10 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.48 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1711215372; cv=none; b=Oue5ahrirQyu2xz/Q6knTKum7G1CRuAdxYPZ0Hf4SEnrnoXVSgvBM1iY5Y3/UgPe5VJHCJQ4aKfWc/68NvSzGYLL3alxnYZqfRfp6rl76T2YiyrlOtPUc7RZ5Y7tz9eFzifqqhQhI/46dXSyF4pTHCboVXt3Y17Dx73L0tCVNvM= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1711215372; c=relaxed/simple; bh=COyyyj4C+H2DJu2s0SQ+BcpL4AUy/y3mDxnoRv3G6NU=; h=Message-ID:Date:MIME-Version:Subject:From:To:References: In-Reply-To:Content-Type; b=MlCCy3knO2lPJQGDxD8VUDE97bgnbBCoJXWBrsV1evJbecgtOyJqSgqMf3t6HvC31IduPQ9SJP9J7sjyevTDKCf3ZTLTAVSGrArIIC3Q96DSlhZ1z3p6E3Zj6QcgA92NmjXAvBFZCZzFqm6NLSp0mVT4vldHP303tpfK2Q+nZ+g= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=jvSoQDLZ; arc=none smtp.client-ip=209.85.128.48 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="jvSoQDLZ" Received: by mail-wm1-f48.google.com with SMTP id 5b1f17b1804b1-41484c4ec03so1851495e9.0 for ; Sat, 23 Mar 2024 10:36:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1711215369; x=1711820169; darn=vger.kernel.org; h=content-transfer-encoding:in-reply-to:content-language:references :to:from:subject:user-agent:mime-version:date:message-id:from:to:cc :subject:date:message-id:reply-to; bh=VbAa3cnpWLlPm+ArXelO7q7566t5BgdcCUzs+JiNo1U=; b=jvSoQDLZIiBSS+IddZBwk9Gs7iFTS0JKB43UBuRCsRUcdo0buvJMsfN98ApTrnjmit bVng7bescWVZPw9cBAXC/hnPFmEoXnFcTLRr+YNID9WPq+QizHvHIRDLgVBJPB38IoOA IKm6Vt08Dcs6pKyuyybL2+2rZ21wTkrTd+3jfyfbH7VfZc+75j3ec+AudTBIayCpuSDq /uCWArrYNTXAJRw73va16mqKGniH1I1ij3turC0f7zHRB8vwsRyWv29hzrEwd16CYuNj SzIsAoih1AzgthUFoPYgKg2fEuvxi86g20mh3YIhmSQd8qfLII2pJ/wTtaG2CLM6kmX/ KD6w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1711215369; x=1711820169; h=content-transfer-encoding:in-reply-to:content-language:references :to:from:subject:user-agent:mime-version:date:message-id :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=VbAa3cnpWLlPm+ArXelO7q7566t5BgdcCUzs+JiNo1U=; b=B/0tBZMAruNRZdO6aAEMSGOTsmr+dn98gYolwfsJczCYgY0FoeBgN2Mwj4D91doWvs ziIGc+3cD5u6o+bjjyyaEVtHPfM3dS5k3WU5D895BFcs4z6tOjLKR1VZxbCZikpu+79U ANMnPcJGTiqg9xRSk5x/54a0swKAs0dx8VdmDBCF/5u+1YFnFo7NdDN0VsosqH4OUUua +A8aCMfERkdIMG3/cAskW4wY4okp+68mOdgJYmtBUATGAytTMvL8aTceomSK+P/8onQR YJeGmyCwi/HSGKHkStczGgp0QtnkfJ3GeFgeB4cuaO7cQUW6uB4nax1du9S59VN4voVH GUWg== X-Gm-Message-State: AOJu0Yz9ZNfgixldt5yt3h5ZnMYrCCKpmY6tM+khdVnaR6M8QM8xs9T2 B5agpmBJpJNZebVoiHkpSgBJbrDuLjv9/dCXuQID/7HRqDZzb06OXAX5DSPx X-Google-Smtp-Source: AGHT+IERFDV6ZFnu4REap8eEHvurGNt0W/t+hULrJGwo0ooxQIrd2WAXJAwYVTDJUqQguN/kDRBPyA== X-Received: by 2002:a05:600c:1912:b0:414:7e73:5673 with SMTP id j18-20020a05600c191200b004147e735673mr1908431wmq.12.1711215368682; Sat, 23 Mar 2024 10:36:08 -0700 (PDT) Received: from gmail.com (181.red-88-14-47.dynamicip.rima-tde.net. [88.14.47.181]) by smtp.gmail.com with ESMTPSA id l21-20020a05600c4f1500b004148213216esm1886714wmq.46.2024.03.23.10.36.05 for (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Sat, 23 Mar 2024 10:36:08 -0700 (PDT) Message-ID: Date: Sat, 23 Mar 2024 18:36:02 +0100 Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: [PATCH 1/2] bugreport: add a new line between questions From: =?utf-8?q?Rub=C3=A9n_Justo?= To: Git List References: <35de2d76-a03e-4a36-9bb7-6b6ffa4ea123@gmail.com> Content-Language: en-US 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 --- 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. From patchwork Sat Mar 23 17:36:51 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Rub=C3=A9n_Justo?= X-Patchwork-Id: 13600724 Received: from mail-wr1-f54.google.com (mail-wr1-f54.google.com [209.85.221.54]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id BA6D2535C4 for ; Sat, 23 Mar 2024 17:36:58 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.54 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1711215420; cv=none; b=ThKqsw8SL7bnNaSKreyZ0V9bT4oFtZEpI3D879Y9oOwa8Ji2pHGcljEtmBdz/gMyKKT2Tv+k86wEr7LMdu2HyLkSXBqf0bWUcyPHCF1KE3VxGMF3rG0xy12rxISuGMevzMTSGSgvBYq/37FdOuogietOnG2PaGx9LWR349LLvnE= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1711215420; c=relaxed/simple; bh=YcC99lOgRL5yf1ZDWQbjsmxqGy42OaBEikb6plazQ8I=; h=Message-ID:Date:MIME-Version:Subject:From:To:References: In-Reply-To:Content-Type; b=gosAxmXB1HNYM0H64NHHp2PttWOrWjYBUFQ33L0xi9uNtRQ0qixahmhI2sC8oc79SK+ZbBdg7+Jfb9VGZ+wlhLmCJlpPc0FZewPuGYeroZRiAuivxZyZU4TYI717xdYH3lt9PmINldaBFbcMGvRSTLbMW5KwIp2pFXJOCKLqBf4= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=QpDj+hVP; arc=none smtp.client-ip=209.85.221.54 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="QpDj+hVP" Received: by mail-wr1-f54.google.com with SMTP id ffacd0b85a97d-33ecb04e018so2029639f8f.1 for ; Sat, 23 Mar 2024 10:36:58 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1711215417; x=1711820217; darn=vger.kernel.org; h=content-transfer-encoding:in-reply-to:references:to:from :content-language:subject:user-agent:mime-version:date:message-id :from:to:cc:subject:date:message-id:reply-to; bh=8IneL7ycCxg5rabSPhRr5UcFzUBhPE59XhcTWAN/83k=; b=QpDj+hVPw4BbP/eaXr1MWGHmCLUu+tZdD08lKMI+7rQscw5EAOPcpeI7gKxzS3JmKw PuWp9v2ZytEbk+d22btM6hS3bpKNaw5cy9MezH9YqQZ3pS4bOmbH61jqmLK+zVWd7yv9 Ihk7QOtCaQve/PEYz7XBrnVUSeT4w7sJ7Ulmprk7G4HqQDdZledbY8pFPXrKTqUoUQUl vPswScx3WQ0UUmZHBWQq5YRKh/HyKsSn2cQIcpSwxgLM5YzrtM4e6cX2QCRWf9QU6lHv c1Re3O3IiBAjqWgbJ4KR/GNJE1TQ/OL8MIlcNHv9Cn34Ff+oREZi/GYQXGUe3ZbVCdRM 883Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1711215417; x=1711820217; h=content-transfer-encoding:in-reply-to:references:to:from :content-language:subject:user-agent:mime-version:date:message-id :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=8IneL7ycCxg5rabSPhRr5UcFzUBhPE59XhcTWAN/83k=; b=FPJPEnzV7qxAVoC49UBTZ2bwJ+Q2Ld7G6y1xxUwJYCTkbl2Bwwi0Z6FAGn/hRQ9Q8K aLf1H02sAvpr6RNjD2KbgEsDWaKBvyH5op2rlkhD/emjYG7WpRF65YsneT3BCmxZY+5o QhbWMR3puDndUCDKFh6WvPhBdY6rIEObVaBtqdavemEBZ2T2lOOc/i+jGtOtTLGmV1Nb 3pMLKGyoAwUsxvtpZKa9ZRaSv8zNimwfUQhNta6KQl9SsS3H9094G+bleOEA9biD5xKN w65yUu/UpdLAy7mLlHg1sEdL/0HJCNrqRxEF5U1sp/kIk8VjDbnGIXJKc4BugLsSVTlV nBBA== X-Gm-Message-State: AOJu0Yxi0/865Z0PxNatnXsg8T6bNhghTcp9FWk4/xKwNP2rYq2YLUKl yEtBJeLC9BiQ+a3WJGrwyDZsNESIhUfV1iOPuM8/NHlQ89l5IpJcEZteSUTE X-Google-Smtp-Source: AGHT+IGdW08Lc4/naUgXHufG5zgsM1FzfiG1FHnn+ATldfk8NpwDwCjU+rrss76jKfETjmuo0rw1CA== X-Received: by 2002:a5d:5287:0:b0:33e:acd8:1422 with SMTP id c7-20020a5d5287000000b0033eacd81422mr1841965wrv.18.1711215416957; Sat, 23 Mar 2024 10:36:56 -0700 (PDT) Received: from gmail.com (181.red-88-14-47.dynamicip.rima-tde.net. [88.14.47.181]) by smtp.gmail.com with ESMTPSA id bx10-20020a5d5b0a000000b00341c3071c93sm1446083wrb.73.2024.03.23.10.36.54 for (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Sat, 23 Mar 2024 10:36:56 -0700 (PDT) Message-ID: <1117b5b1-fb9e-49b8-b1c3-47b985adce35@gmail.com> Date: Sat, 23 Mar 2024 18:36:51 +0100 Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: [PATCH 2/2] bugreport: add a mark to each proposed questions Content-Language: en-US From: =?utf-8?q?Rub=C3=A9n_Justo?= To: Git List References: <35de2d76-a03e-4a36-9bb7-6b6ffa4ea123@gmail.com> In-Reply-To: <35de2d76-a03e-4a36-9bb7-6b6ffa4ea123@gmail.com> 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 --- builtin/bugreport.c | 8 ++++---- t/t0091-bugreport.sh | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) 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: