Merge pull request #22 from CodeYourFuture/update-review-guides

Update review and help guidance markdowns

Author: Dedekind561

.github/pull_request_template.md

@@ -0,0 +1,32 @@
+<!--
+
+You must title your PR like this:
+
+COHORT_NAME | FIRST_NAME LAST_NAME | REPO_NAME | WEEK
+
+For example,
+
+NW4 | Carol Owen | HTML-CSS-Module | Week1
+
+Complete the task list below this message.
+If your PR is rejected, check the task list.
+
+-->
+
+## Learners, PR Template
+
+Self checklist
+
+- [ ] I have committed my files one by one, on purpose, and for a reason
+- [ ] I have titled my PR with COHORT_NAME | FIRST_NAME LAST_NAME | REPO_NAME | WEEK 
+- [ ] I have tested my changes
+- [ ] My changes follow the [style guide](https://syllabus.codeyourfuture.io/guides/code-style-guide/)
+- [ ] My changes meet the [requirements](./README.md) of this task
+
+## Changelist
+
+Briefly explain your PR.
+
+## Questions
+
+Ask any questions you have for your reviewer.

HOW_TO_REVIEW.md

@@ -0,0 +1,66 @@
+<!--
+Do not edit this file.
+Make a change to the template and then pull changes
+Repo: https://github.com/CodeYourFuture/Module-Template
+-->
+
+# Everyone reviews code at CYF
+
+Mentors and trainees all review code, and collaborate on improving code quality. We are all helping each other to talk, write, and think about code more clearly.
+
+We are not reviewing code as if we were to merge this PR into production; we are opening a technical conversation for the purpose of insight and development.
+
+## Key points:
+
+1. Ask questions instead of making statements:
+
+   **YES:** "Is there another element you could use to group a set of fields in a form? Why might someone use a different element in a form?"
+   **NO:** "Use fieldset not divs"
+
+2. Encourage simplicity, clarity, and precision:
+
+   **YES** "There are 15,0000 files in this changelist. Which files should be reviewed?"
+   **NO** "It doesn't matter; I can try to figure out what you meant."
+
+3. Respect everyone's work and time:
+
+   **YES** "I think there's some more to do here. Thanks for sharing where you're up to."
+   **NO** "This is rubbish. Try harder."
+
+## Labels
+
+Reviewers, please add labels (provided) to the PR once you've reviewed. This helps to focus the trainee on the areas they should work on, and gives an overview for mentors on what the whole cohort needs to work on.
+
+## Solutions
+
+### Where to find solutions?
+
+You can find the solutions for the module on the `solutions` branch.
+
+### Solutions branch
+
+The solutions branch typically contains:
+
+#### Sample solutions
+
+Solutions are example answers not the only correct answers.
+
+#### Common responses guides.
+
+Everyone is invited to contribute commonly encountered problems, mistakes, misunderstandings, and mental-model errors to our common responses documents.
+
+Use these resources to inform your code review, get unstuck, and improve your understanding.
+
+## Guides
+
+Here's a detailed checklist of the sorts of things we should check code for:
+
+https://syllabus.codeyourfuture.io/guides/marking-guide
+
+Here's a detailed style guide to help us all write clear, high quality code:
+
+https://syllabus.codeyourfuture.io/guides/code-style-guide
+
+Here's some help with giving good feedback during code review:
+
+https://teachertraining.codeyourfuture.io/tasks/code-review

contributing.md

@@ -0,0 +1,25 @@
+<!--
+Do not edit this file.
+Make a change to the template and then pull changes
+Repo: https://github.com/CodeYourFuture/Module-Template
+-->
+
+# How To Submit Your Coursework
+
+Use Git & Github to submit your coursework as a pull request.
+
+The Github Desktop cheatsheet will help you.
+
+[Github Desktop Cheatsheet](http://syllabus.codeyourfuture.io/git/cheatsheet)
+
+This module will help you submit your coursework.
+
+[Git](http://syllabus.codeyourfuture.io/git/index)
+
+## Questions & Help
+
+Contributing to a remote codebase is a necessary skill for a professional developer. Opening PRs is mandatory at CYF. It is part of the coursework.
+
+If you cannot submit your coursework you **must** post on Slack to get unblocked.
+
+[How to get help](./HOW-TO-GET-HELP.md)