Questions
First, always look to see if your question has been asked before creating another one.
To start, click the "Issues" tab in the above menu.
When you get there, you will see a question already there. This is an example question so that you can explore what a well formatted question looks like.
Something to note is you should see tags next to the question entry. The purple 'question' tag represents that this is a question. The green 'resolved' tag lets users know that the question has been resolved.
For anybody that knows about GitHub, you may wonder why we don't just close the issue. Our reasoning is that we want a simple interface fore incoming users to quickly see the questions that have been asked instead of expecting them to navigate between open and closed questions.
If your question has not been asked before, click on the 'New Issue' button:
This will take you to a screen that will ask you what kind of issue you want to create. Out of the options available, please select Question's 'Get Started'.
We have setup a helpful template that should guide you through how to make a properly formatted question.
A screen will pop up that looks like this:
This is a text-entry field that uses what is called Markdown formatting. For more information on how to use it, go to https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf
If, at any time, you want to see if how your question looks after formatting, click the 'Preview' tab:
This will take your markdown formatted text and render it. The particularly helpful thing about markdown is that it allows us display code separate from text (something that Word and Canvas don't do well).
Here are some quick tips regarding markdown format:
- To make something bold, use **bold**
- To make something italic, use _italic_
- To make a word look like
code, surround the word with ` (backtick, just above the tilde ~)- Example, to make
code, we would type `code`
- Example, to make
- To make blocks of syntax highlighted code, we use code blocks:
- To make:
print('Hello, World!')
- We would type:
```python (or whatever syntax you are using)
print('Hello, world')
```
Lastly, GitHub does something really nice for people that are writing issues. Anytime you need to insert a screenshot, all you have to do is take your screenshot and paste it into the text-entry area. It should automatically add a line that looks like this:
Just fill out the relevant parts of the question template, and click 'Submit new issue'.
