From de278b1b505e6041fb743c2f233bca4999669e6d Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Tue, 16 Apr 2024 15:43:26 +0800 Subject: [PATCH 1/4] add render: shell to bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index e28e5408208..200c7e60856 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -66,6 +66,7 @@ body: the line containing the command with `$ `. Please also ensure that the "How to reproduce" section contains matching instructions for reproducing this. + render: shell - type: checkboxes attributes: From a4155610c608c20afdea04a9a68116ff37fd13e5 Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Tue, 16 Apr 2024 16:17:09 +0800 Subject: [PATCH 2/4] add news file --- news/12630.trivial.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 news/12630.trivial.rst diff --git a/news/12630.trivial.rst b/news/12630.trivial.rst new file mode 100644 index 00000000000..8beb79ec366 --- /dev/null +++ b/news/12630.trivial.rst @@ -0,0 +1 @@ +Add ``render: shell`` to the bug report template to format output as code From db425ce4b49d9ff59954fb5c506bffc5e42f9c0f Mon Sep 17 00:00:00 2001 From: Peter Shen Date: Thu, 18 Apr 2024 10:47:31 +0800 Subject: [PATCH 3/4] update output description --- .github/ISSUE_TEMPLATE/bug-report.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 200c7e60856..e593031d559 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -60,7 +60,8 @@ body: label: Output description: >- Provide the output of the steps above, including the commands - themselves and pip's output/traceback etc. + themselves and pip's output/traceback etc. + (The output will auto-rendered as code, no need for backticks.) If you want to present output from multiple commands, please prefix the line containing the command with `$ `. Please also ensure that From 7b61a10379169b5f7e8eed042aa16ffd7d76ad7b Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Thu, 18 Apr 2024 03:00:06 +0000 Subject: [PATCH 4/4] fixed trim trailing whitespace --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index e593031d559..20e0a5dd991 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -60,7 +60,7 @@ body: label: Output description: >- Provide the output of the steps above, including the commands - themselves and pip's output/traceback etc. + themselves and pip's output/traceback etc. (The output will auto-rendered as code, no need for backticks.) If you want to present output from multiple commands, please prefix