diff --git a/projects/project_01/README.md b/projects/project_01/README.md index fbba575..17ef0ed 100644 --- a/projects/project_01/README.md +++ b/projects/project_01/README.md @@ -1,5 +1,5 @@ -## Attendance for the week: +## Attendance You are required to be present by 10:00 am EDT each day during the project. ## Standups @@ -31,6 +31,27 @@ Whole class instruction on how to deploy your project to the world wide web. 1. Seek out help online 2. Seek out help with your classmates 3. Seek out help with Derek (TA) -4. Submit a Github issue to receive help from an instructor: +4. Submit a Github issue to receive help from an instructor +## Formatting your GitHub Issue to ask for help +*PUSH OFTEN! Your code on GitHub should be up to date. Submiting an issue and linking us to old, out-of-date code will hinder the process.* + +### CONTEXT + +#### WHAT YOU ARE TRYING TO SOLVE: +*Write a detailed explanation of the feature or user story you're working on.* + +#### DETAILED DESCRIPTION OF THE BUG/ERROR: +*A detailed description of the problem, the bug, and/or the error.* + +*This means: the full steps to reproduce, a link to the file on github, and the line number of where the relavent code is. +The error(s) returned, copy and pasted/typed out/screenshot, not paraphrased.* + +*If there is other code in a different file that is also essential to the functioning of the code that currently works point us to that and explain the relationship.* + +### WHAT I'VE TRIED +*List everything you've done to solve the bug on your own in detail. list all resources you've looked up and tried to implement and provide links. Providing code if you have it surrounded by the md syntax to display nicely is very helpful.* + +### QUESTION +*After going through all this what is your questions specifically, more specifically than how can I make this work?*