Asking Questions

In order to make is easy for people to answer your questions when asking for help it's important that you have the following information

  • The homework that you're working on

  • What isn't working in your code or what you don't understand

  • What you expect to happen

  • A link to your code on Github

You should use this template:

Homework:
Problem:
Expected:
Code:

For example

Homework: Create a Website
Problem: The Headings on my website don't look right.
Expected: The heading should be much bigger than the other text on the page. I've tried to use a H1 tag but it doesn't work
Code: https://github.com/CodeYourFuture/my-website/pull/46

Question Check List

Before asking a questions make sure that you've completed all of these steps

  1. Have you done some research before asking the question?

  2. Have you explained what you’ve already tried to solve your problem?

  3. Have you specified which language and platform you’re using, including version number where relevant?

  4. If your question includes code, have you written it as a short but complete program?

  5. If your question includes code, have you checked that it’s correctly formatted?

  6. If your question doesn’t include code, are you sure it shouldn’t?

  7. If you get an error message, have you included the exact error message?

  8. If your program throws an exception, have you included the exception, with both the message and the stack trace?

  9. If your program produces different results to what you expected, have you stated what you expected, why you expected it, and the actual results?

  10. Have you checked that your question looks reasonable in terms of formatting?

  11. Have you checked the spelling and grammar to the best of your ability?

  12. Have you read the whole question to yourself carefully, to make sure it makes sense and contains enough information for someone coming to it without any of the context that you already know?

After you've asked your question you should make sure

  1. Are you monitoring your questions?

  2. Have you posted an easy to understand answer to your questions that includes everything you learnt

By completing all of these steps you make it really easy for other students to learn from your question and for you to get help quickly.