Skip to content

Commit

Permalink
Corrected styling.
Browse files Browse the repository at this point in the history
  • Loading branch information
ychaikin committed Dec 4, 2016
1 parent 18585ff commit 79a962d
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions FAQ.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
## Most Important!
- [How to ask and get your question answered - A MUST READ!](#how-to-ask-and-get-your-question-answered-a-must-read)

## Computer and Environment Setup
- [What is a terminal and how do I open it?](#q-what-is-a-terminal-and-how-do-i-open-it)
- [What is a command prompt?](#q-what-is-a-command-prompt)
Expand Down Expand Up @@ -37,7 +38,7 @@

***

## Most Important!
### Most Important!

####**Q: How to ask and get your question answered - A MUST READ!**
A: There is a simple theme to this answer: Help others help you!
Expand All @@ -50,15 +51,15 @@ However, even if you do provide some details, they must be the right details so

Here is a general guide as to what you should provide:

1) Describe your issue with specifics. Don't just say "it doesn't work." Explain what isn't working correctly with steps of what you did when you are experiencing this behavior.
1. Describe your issue with specifics. Don't just say "it doesn't work." Explain what isn't working correctly with steps of what you did when you are experiencing this behavior.

2) Commit your code with the issue to GitHub and provide 2 links:
2. Commit your code with the issue to GitHub and provide 2 links:
* Link to your repository where people can clone your code and quickly look at it on their own machines.
* Link to your *deployed* website (using github.io, i.e., GitHub Pages) so people don't have to spend their time trying to deploy your site just to see for themselves what's going on.

*Rarely (but it happens), it's appropriate to simply provide a **small** code snippet that you have a question about. When you do, make sure to use the <> code formatter on Coursera to place your code snippet into the post. Don't just copy/paste it straight into the text of the post. It's very hard to read.*

3) If you are having issues with installation, GitHub, etc., make sure to describe what you did with enough detail, and if there are errors or logs that you saw, you need to include those in your question. Simply saying "It doesn't let me push my code to the repository" won't do. If you tried to push the code and it didn't work, there were error messages that were displayed. Provide those messages, including the exact command you used.
3. If you are having issues with installation, GitHub, etc., make sure to describe what you did with enough detail, and if there are errors or logs that you saw, you need to include those in your question. Simply saying "It doesn't let me push my code to the repository" won't do. If you tried to push the code and it didn't work, there were error messages that were displayed. Provide those messages, including the exact command you used.

**Last, but certainly not least!** I can't recount every scenario that can occur in this short guide. **Use common sense.** Ask yourself: If I came up to a total stranger in this class and showed them my post, would they have enough information to help me or would they for sure have to ask me something? If they would have to ask you something, you are not done with your post. Yes, of course, there are times when you yourself don't know what you don't know. That's ok. Just put in an honest effort to HELP OTHERS HELP YOU.

Expand Down

0 comments on commit 79a962d

Please sign in to comment.