Skip to content

Commit

Permalink
issue template: improve the "installation difficulties" template
Browse files Browse the repository at this point in the history
to reflect the questions I ask when problems get really nutty
  • Loading branch information
flavorjones committed Sep 5, 2020
1 parent 1ae26a6 commit 9eda2bf
Showing 1 changed file with 44 additions and 8 deletions.
52 changes: 44 additions & 8 deletions .github/ISSUE_TEMPLATE/installation-difficulties.md
Expand Up @@ -9,22 +9,58 @@ assignees: ''

**Have you read and followed the installation tutorial at http://www.nokogiri.org/tutorials/installing_nokogiri.html?**

**What is the complete output of `gem install`?**
- [ ] Yes!

Please make sure to escape the file contents with triple-backticks.

**What is the complete output of `gem install` or `bundle install`?**

<!-- Please make sure to escape the file contents with triple-backticks. -->

```
your output goes here
```


**What are the complete contents of the `mkmf.log` file generated during the failed installation?**

Please make sure to escape the file contents with triple-backticks.
<!-- Please make sure to escape the file contents with triple-backticks. -->

```
your mkmf.log file contents go here
```


**Tell us about your system!**

What is the output from `ruby -v`?

What is the output from `gem -v`?

What is the output from `gem env`?

```
gem env output goes here
```


**What operating system are you using?**
If you're using Bundler:
- what is the output from `bundle version`?
- what is the output from `bundle config`? (Take care to redact any credentials)

Are you using Linux, MacOS, Windows, a BSD variant, or something else entirely?
```
bundle config output goes here
```

If MacOS, please note the version of XCode you have installed.
If you're on MacOS, please note:
- the version of XCode you have installed (if you know)
- the output of `gcc -v` or `clang -v`

If Linux, please include the output of `uname -a` and the contents of `/etc/lsb-release`.
If Linux or a BSD variant, please note:
- the distro you're using
- the output of `uname -a`
- the contents of `/etc/lsb-release`.

If Windows, please note whether you're installing the precompiled gems, or compiling yourself with DevKit. Also please note the version of RubyInstaller you've installed.
If Windows, please note:
- whether you're installing the precompiled gems, or compiling yourself with DevKit
- the version of RubyInstaller you've installed
- or if you're not using RubyInstaller, how did you install Ruby?

0 comments on commit 9eda2bf

Please sign in to comment.