diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 93586afe..9b9cc912 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,11 +2,11 @@ You must title your PR like this: -COHORT_NAME | FIRST_NAME LAST_NAME | REPO_NAME +COHORT_NAME | FIRST_NAME LAST_NAME | REPO_NAME | WEEK For example, -NW4 | Carol Owen | HTML-CSS-Coursework-Week1 +NW4 | Carol Owen | HTML-CSS-Module | Week1 Complete the task list below this message. If your PR is rejected, check the task list. @@ -18,7 +18,7 @@ If your PR is rejected, check the task list. 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 +- [ ] 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 diff --git a/HOW-TO-GET-HELP.md b/HOW-TO-GET-HELP.md deleted file mode 100644 index 8e3aaeb0..00000000 --- a/HOW-TO-GET-HELP.md +++ /dev/null @@ -1,46 +0,0 @@ - - -# How To Get Help - -Learning to ask good questions is a key skill for a developer and you should practice this every week at CYF. You must spend a lot of time learning how to describe problems clearly and systematically: - -https://syllabus.codeyourfuture.io/guides/asking-questions - -Problem-solving is the real (marketable) skill of software developers. If you do not have questions to ask about your work, ask for some different work. Don't miss this opportunity to break down challenging problems with a large team of developers. - -## Guide - -Please review our guide on the Syllabus for how to get help when you are really blocked: - -https://syllabus.codeyourfuture.io/guides/escalation-policy/ - -You should complete all of the steps in the order listed to get help. - -## Reporting Issues in Coursework - -- Is there a problem with this coursework? -- Have you noticed a bug? -- Is there a typo or a mistake you can help clean up? - -Post in the channel named after the module you are working on: - -- Git - `cyf-module-git` -- HTML/CSS - `cyf-module-html-css` -- JavaScript Core 1 - `cyf-module-js1` -- JavaScript Core 2 - `cyf-module-js2` -- JavaScript Core 2 - `cyf-module-js3` -- React - `cyf-module-react` -- Node - `cyf-module-node` -- SQL - `cyf-module-sql` -- MongoDB - `cyf-module-mongodb` - -Or open an issue directly to the Syllabus. CYF Syllabus is an Open Source project developed on GitHub and you are invited to contribute. Read the Issue Template carefully. - -https://github.com/CodeYourFuture/syllabus/issues/new/choose - -Still not clear where to share your issue? Post in #cyf-syllabus-tech. diff --git a/HOW_TO_REVIEW.md b/HOW_TO_REVIEW.md index 56b2e9d6..1afda184 100644 --- a/HOW_TO_REVIEW.md +++ b/HOW_TO_REVIEW.md @@ -1,8 +1,7 @@ # Everyone reviews code at CYF @@ -36,25 +35,11 @@ Reviewers, please add labels (provided) to the PR once you've reviewed. This hel ### Where to find solutions? -Add `-Solution` to the end of a repo url to find the solution. +You can find the solutions for the module on the `solutions` branch. -For this repo: +### Solutions branch -https://github.com/CodeYourFuture/JavaScript-Core-1-Coursework-Week1 - -Find the solution here: - -https://github.com/CodeYourFuture/JavaScript-Core-1-Coursework-Week1-Solution - -**_If you get a 404_** - -**Mentors:** Join your Github Team - ask in Slack or look in the pinned posts in the top of your channel. - -**Trainees** get solution repos one week later. Ask your mentors in Slack if you are getting a 404. - -### Using the Solutions Repo - -Solutions repo typically contain: +The solutions branch typically contains: #### Sample solutions diff --git a/HOW-TO-SUBMIT.md b/contributing.md similarity index 81% rename from HOW-TO-SUBMIT.md rename to contributing.md index 9c8256fe..65409729 100644 --- a/HOW-TO-SUBMIT.md +++ b/contributing.md @@ -1,8 +1,7 @@ # How To Submit Your Coursework