Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise Troubleshooting.md #1453

Merged
merged 4 commits into from
Nov 8, 2016
Merged

Conversation

ddbeck
Copy link

@ddbeck ddbeck commented Nov 6, 2016

After having a bit of difficulty with the troubleshooting steps in a previous issue, I've tried to revise the Troubleshooting document to:

  • make the doc easier to follow top to bottom (e.g., putting troubleshooting steps in order of specificity, putting issue contents guidelines after all of the troubleshooting steps, and adding some section signposting)
  • rephrase things to capture formula-related problems that are not explicitly build failures

I also tweaked a few things here and there to be (hopefully) more readable. Thanks for considering my PR!


  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • [N/A] Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew tests with your changes locally?

Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small comment otherwise this looks great and is an improvement, thanks!

@@ -1,26 +1,34 @@
# Troubleshooting
**Run `brew update` (twice) and `brew doctor` *before* creating an issue!**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would rather leave this at the top as people often don't read more than the first line here, sadly.

@scpeters
Copy link
Member

scpeters commented Nov 7, 2016

I agree, thanks for clarifying the debugging steps!

@ddbeck
Copy link
Author

ddbeck commented Nov 7, 2016

OK, I've brought back the attention-grabbing first line and tweaked the introduction to match up with that a little better. Let me know if you want to see any other changes. Thanks!

@MikeMcQuaid MikeMcQuaid merged commit 42bb0f8 into Homebrew:master Nov 8, 2016
@MikeMcQuaid
Copy link
Member

Thanks for your contribution to Homebrew! Without people like you submitting PRs we couldn't run this project. You rock!

@Homebrew Homebrew locked and limited conversation to collaborators May 3, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants