Skip to content

Commit 0a3bf2e

Browse files
Improve bug report instructions
* Explicitly recommend copying full command output and not just the bug report template part. * Include quadruple quotes in the "What actually happened section" and tell users to copy full command output inside. Hopefully quadruple quotes will make the error report information (which includes triple quotes itself) render fine by default. * Avoid "actually" as per quality_spec.rb recommendation.
1 parent 4062ebf commit 0a3bf2e

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

.github/ISSUE_TEMPLATE/bundler-related-issue.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,11 @@ Ideally, we recommend you set up the list of steps as a Dockerfile. A Dockerfile
5959

6060
<!-- Replace this with the results you expected before running the command. -->
6161

62-
### What actually happened?
62+
### What happened instead?
6363

64-
<!-- Replace this with the actual result you got. Paste the output of your command here. -->
64+
````
65+
Replace this with the actual result you got. Paste the output of your command here.
66+
````
6567

6668
### If not included with the output of your command, run `bundle env` and paste the output below
6769

bundler/lib/bundler/friendly_errors.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ def request_issue_report_for(e)
8080
First, try this link to see if there are any existing issue reports for this error:
8181
#{issues_url(e)}
8282
83-
If there aren't any reports for this error yet, please fill in the new issue form located at #{new_issue_url}, and copy and paste the report template above in there.
83+
If there aren't any reports for this error yet, please fill in the new issue form located at #{new_issue_url}. Make sure to copy and paste the full output of this command under the "What happened instead?" section.
8484
EOS
8585
end
8686

0 commit comments

Comments
 (0)