admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Merge pull request #2618 from MikeMcQuaid/issue-troubleshooting-tweaks

Browse Source 
Tweak troubleshooting docs and issue template
This commit is contained in:
Mike McQuaid 2017-05-10 11:36:55 -05:00 committed by GitHub
commit fa1e23823c
2 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
.github/ISSUE_TEMPLATE.md vendored
View File

@ -1,17 +1,17 @@
# Please always follow these steps: # Please always follow these steps:
- [ ] Confirmed this is a problem with Homebrew/brew and not one or more formulae? If it's a formulae-specific problem please file this issue at https://github.com/Homebrew/homebrew-core/issues/new - [ ] Confirmed this is a problem with running a `brew` command and just `brew install`ing one or more formulae? If it's a formulae-specific problem please file this issue at https://github.com/Homebrew/homebrew-core/issues/new
- [ ] Ran `brew update` and retried your prior step? - [ ] Ran `brew update` and retried your prior step?
- [ ] Ran `brew doctor`, fixed as many issues as possible and retried your prior step? - [ ] Ran `brew doctor`, fixed all issues and retried your prior step?
- [ ] Ran `brew config` and `brew doctor` and included their output with your issue? - [ ] Ran `brew config` and `brew doctor` and included their output with your issue?
**Please note we may immediately close your issue without comment if you delete or do not fill out the issue checklist and provide ALL the requested information.**
To help us debug your issue please explain: To help us debug your issue please explain:
- What you were trying to do (and why) - What you were trying to do (and why)
- What happened (include command output) - What happened (include command output)
- What you expected to happen - What you expected to happen
- Step-by-step reproduction instructions (by running `brew` commands) - Step-by-step reproduction instructions (by running `brew` commands)
**Please note we may immediately close your issue without comment if you do not fill out the issue template and provide ALL the requested information.**
# Or propose a feature: # Or propose a feature:
Please replace this section with a detailed description of your proposed feature, the motivation for it and alternatives considered. Please replace this section with a detailed description of your proposed feature, the motivation for it, how it would be relevant to at least 90% of Homebrew users and alternatives considered.
Please note we may close this issue or ask you to create a pull-request if it's something we're not actively planning to work on. Please note we may close this issue or ask you to create a pull-request if it's something we're not actively planning to work on.

3
docs/Troubleshooting.md
View File

@ -13,12 +13,11 @@ Follow these steps to fix common problems:
* Check that **Command Line Tools for Xcode (CLT)** and **Xcode** are up to date. * Check that **Command Line Tools for Xcode (CLT)** and **Xcode** are up to date.
* If commands fail with permissions errors, check the permissions of `/usr/local`'s subdirectories. If you’re unsure what to do, you can run `cd /usr/local && sudo chown -R $(whoami) bin etc include lib sbin share var Frameworks`. * If commands fail with permissions errors, check the permissions of `/usr/local`'s subdirectories. If you’re unsure what to do, you can run `cd /usr/local && sudo chown -R $(whoami) bin etc include lib sbin share var Frameworks`.
* Read through the [Common Issues](Common-Issues.md). * Read through the [Common Issues](Common-Issues.md).
* If you’re installing something Java-related, make sure you have installed Java (you can run `brew cask install java`).
## Check to see if the issue has been reported ## Check to see if the issue has been reported
* Search the [issue tracker](https://github.com/Homebrew/homebrew-core/issues) to see if someone else has already reported the same issue. * Search the [issue tracker](https://github.com/Homebrew/homebrew-core/issues) to see if someone else has already reported the same issue.
* Make sure you search issues on the correct repository. If a formula that has failed to build is part of a tap like [homebrew/science](https://github.com/Homebrew/homebrew-science/issues) or [homebrew/dupes](https://github.com/Homebrew/homebrew-dupes/issues) check those issue trackers instead. * Make sure you search issues on the correct repository. If a formula that has failed to build is part of a tap like [homebrew/science](https://github.com/Homebrew/homebrew-science/issues) or a cask is part of [caskroom/cask](https://github.com/caskroom/homebrew-cask/issues) check those issue trackers instead.
## Create an issue ## Create an issue