mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
Unify issue template and ISSUES.md document
Some crucial information to ease maintainers work, like the advice of upgrading rubygems and bundler, was one step away from the issue template, making it easier for some users to miss. Now all relevant information is written directly in the bug report template.
This commit is contained in:
parent
b4a43e4f57
commit
9fbf3a1f6f
2 changed files with 9 additions and 33 deletions
|
@ -20,9 +20,10 @@ module Bundler
|
|||
|
||||
Hopefully the troubleshooting steps above resolved your problem! If things
|
||||
still aren't working the way you expect them to, please let us know so
|
||||
that we can diagnose and help fix the problem you're having. Please
|
||||
view the Filing Issues guide for more information:
|
||||
https://github.com/rubygems/rubygems/blob/master/bundler/doc/contributing/ISSUES.md
|
||||
that we can diagnose and help fix the problem you're having, by filling
|
||||
in the new issue form located at
|
||||
https://github.com/rubygems/rubygems/issues/new?labels=Bundler&template=bundler-related-issue.md,
|
||||
and copy and pasting the information below.
|
||||
|
||||
EOS
|
||||
|
||||
|
|
|
@ -63,34 +63,6 @@ module Bundler
|
|||
def request_issue_report_for(e)
|
||||
Bundler.ui.error <<-EOS.gsub(/^ {8}/, ""), nil, nil
|
||||
--- ERROR REPORT TEMPLATE -------------------------------------------------------
|
||||
# Error Report
|
||||
|
||||
## Questions
|
||||
|
||||
Please fill out answers to these questions, it'll help us figure out
|
||||
why things are going wrong.
|
||||
|
||||
- **What did you do?**
|
||||
|
||||
I ran the command `#{$PROGRAM_NAME} #{ARGV.join(" ")}`
|
||||
|
||||
- **What did you expect to happen?**
|
||||
|
||||
I expected Bundler to...
|
||||
|
||||
- **What happened instead?**
|
||||
|
||||
Instead, what happened was...
|
||||
|
||||
- **Have you tried any solutions posted on similar issues in our issue tracker, stack overflow, or google?**
|
||||
|
||||
I tried...
|
||||
|
||||
- **Have you read our issues document, https://github.com/rubygems/rubygems/blob/master/bundler/doc/contributing/ISSUES.md?**
|
||||
|
||||
...
|
||||
|
||||
## Backtrace
|
||||
|
||||
```
|
||||
#{e.class}: #{e.message}
|
||||
|
@ -109,8 +81,7 @@ module Bundler
|
|||
First, try this link to see if there are any existing issue reports for this error:
|
||||
#{issues_url(e)}
|
||||
|
||||
If there aren't any reports for this error yet, please copy and paste the report template above into a new issue. Don't forget to anonymize any private data! The new issue form is located at:
|
||||
https://github.com/rubygems/rubygems/issues/new?labels=Bundler&template=bundler-related-issue.md
|
||||
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.
|
||||
EOS
|
||||
end
|
||||
|
||||
|
@ -121,6 +92,10 @@ module Bundler
|
|||
"https://github.com/rubygems/rubygems/search?q=" \
|
||||
"#{CGI.escape(message)}&type=Issues"
|
||||
end
|
||||
|
||||
def new_issue_url
|
||||
"https://github.com/rubygems/rubygems/issues/new?labels=Bundler&template=bundler-related-issue.md"
|
||||
end
|
||||
end
|
||||
|
||||
def self.with_friendly_errors
|
||||
|
|
Loading…
Add table
Reference in a new issue