Guide to Asking Coding Questions
# **Guide to Asking Coding Questions**
## **Why?**
Good questions help your question be solved faster, and people will want to answer your question
Bad questions waste time, you will often not get answers that you asked for, and people will often ignore your questions
## **Quick Questions Guide**
### Do This
- Always ask your questions in English
- Explain what you want the code to do
- Explain what the code does
- Include error messages
- Share the repl with the line numbers
- When you figure out the answer, update your post
- Put the repl link, instead of pasting code
### Don't Do This
- Don't post homework questions
- Don't use caps in the title
- Don't use words like 'HELP' or 'PLEASE' in the title
- Don't post questions that already have an answer (Search Box)
- Don't post feedback or bugs on Talk, use [repl.it/feedback](https://repl.it/feedback) for feedback, or [repl.it/bugs](https://repl.it/bugs) for bugs
## **Steps For Better Questions**
1. Understand the code
- Read your code and figure out what each line does
- If a concept is unfamiliar, Google it
- You can also use a debugger to help you
2. Describe the problem
- Explain what you want the code to do
- Explain what the code does (error messages)
3. Provide the code
- Share a repl that has your code
- Share the line number(s) of your code issue
- Make sure that the code you shared has the issue
4. Format code consistently
- Make sure your code is easy to read
5. Check for typos
- Make sure the code does not have any typos that would cause the problem
6. Explain what you did to troubleshoot the problem
- Make a list of what you think the problem is and try to fix your problem by going through the list
7. Make a guess on what you think the problem might be
- Use the list from the previous step
8. Proofread the question
- Make sure you provided everything
- Clear all confusions that you think there might be
9. Update people on the question
- If you figured out the answer, edit the post to tell people
- When you get an answer, fully understand it
- Be nice to people who answer your question
- Remember that the people wanted to answer your question, but didn't have to
10. Things to NOT do
- Don't post homework questions
- Only post questions in English
- Do not use caps in the title
- Do not use "HELP" or "PLEASE" in the title
- Don't post questions that have already been answered (Use search box)
- Don't post feedback or bugs on Talk, use [repl.it/feedback](https://repl.it/feedback) for feedback, or [repl.it/bugs](https://repl.it/bugs) for bugs
## **Example:**
### **Question**
We have some Python code with an error: [repl](https://repl.it/@Mosrod/Question-Tutorial)
```python
rannumexe = int(input())
if rannumexe = 1:
print('hi' + rannumexe)
```
### Step 1
We show what each line does using comments.
```python
rannumexe = int(input()) # Asks the user to input a rannumexe
if rannumexe = 1: # If the rannumexe equals 1
print('hi' + rannumexe) # Print hi and the rannumexe
```
### Step 2
We want the code to input a number, and if the number is one, print "hi" and the number.
Our problem is that we have an invalid syntax error on line 2 in the main.py file.
```
File "main.py", line 2
if rannumexe = 1:
^
SyntaxError: invalid syntax
```
### Step 3
Our repl with the issue is located [here](https://repl.it/@Mosrod/Question-Tutorial).
We have an issue on line 2
### Step 4
We can change "rannumexe" to "number" to clear confusion
```python
number = int(input()) # Asks the user to input a number
if number = 1: # If the number equals 1
print('hi' + number) # Print hi and the number
```
### Step 5
We don't have any typos
### Step 6
Our problem could be that we improperly used the if statement
### Step 7
The problem could be about using the if statement incorrectly
### Step 8
Our final question:
Title:
Invalid syntax error about equal signs
Content:
I have an invalid syntax error on line 2 in the main.py file of this [repl](https://repl.it/@Mosrod/Question-Tutorial). The program should take a number as an input, check if the number is equal to one, and if so, print "hi" and the number. The error point to the equal signs and I think this issue is with the incorrect syntax of the if statement. Help is appreciated :).
```python
number = int(input()) # Asks the user to input a number
if number = 1: # If the number equals 1
print('hi' + number) # Print hi and the number
```
```
File "main.py", line 2
if rannumexe = 1:
^
SyntaxError: invalid syntax
```
Steps based on Gordon Zhu's [post](https://medium.com/@gordon_zhu/how-to-be-great-at-asking-questions-e37be04d0603).
If you have any suggestions or feedback, post it in the comments below.
