diff --git a/common-content/en/module/complexity/clean-code-workshop/index.md b/common-content/en/module/complexity/clean-code-workshop/index.md deleted file mode 100644 index 02dc6e914..000000000 --- a/common-content/en/module/complexity/clean-code-workshop/index.md +++ /dev/null @@ -1,18 +0,0 @@ -+++ -title = "Clean Code Workshop" -time = 45 -objectives = [ - "Identify properties which make code easier to read and modify.", - "Compare the cleanliness of code.", -] -[build] - render = "never" - list = "local" - publishResources = false -+++ - -Open [this Clean Code workshop presentation](https://docs.google.com/presentation/d/1G6XjmL7U9013v0Pw9R5nHrzRdWdnNzdbDUBMy_gdJpk/edit). Work through the whole thing together as a group. The "Gilded Rose" Kata is not required to be done in class, but we recommend you try it on your own after class if you didn't get to it. - -For each "Better or worse?" question, every member of the class should move to one side of the room or the other to vote for which piece of code they prefer. - -People who voted each way should share with the class why they prefer the code they voted for. diff --git a/common-content/en/module/js3/dead-code/index.md b/common-content/en/module/js1/dead-code/index.md similarity index 96% rename from common-content/en/module/js3/dead-code/index.md rename to common-content/en/module/js1/dead-code/index.md index 0c0865cd5..0d947c774 100644 --- a/common-content/en/module/js3/dead-code/index.md +++ b/common-content/en/module/js1/dead-code/index.md @@ -1,5 +1,5 @@ +++ -title = 'Dead code' +title = 'Dead Code' time = 30 [objectives] @@ -24,7 +24,7 @@ Clean code generally means code that is: - **Understandable for other programmers.** We achieve this through good variable naming, avoiding chaining too many methods in one line, good choice of syntax depending on the data type being used, etc. - **Avoids duplication**. - Not repeating code where it could be a reusable function, making more efficient if/else statements, using loops where relevant, etc. + Not repeating code where it could be a reusable function, making more efficient choices in our conditional logic, using loops where relevant, etc. - **Passes all tests** (if you have tests in the repository). - And importantly, contains a **minimal amount of "moving parts"**. diff --git a/org-cyf-itp/content/data-flows/sprints/3/prep/index.md b/org-cyf-itp/content/data-flows/sprints/3/prep/index.md index 10fbc6261..ddf774981 100644 --- a/org-cyf-itp/content/data-flows/sprints/3/prep/index.md +++ b/org-cyf-itp/content/data-flows/sprints/3/prep/index.md @@ -13,9 +13,6 @@ src="https://www.youtube.com/watch?v=J-0XkB54yp8" name="Latency" src="module/js3/latency" [[blocks]] -name="Dead Code" -src="module/js3/dead-code" -[[blocks]] name="Synchronous execution" src="module/js3/synchronous-execution" [[blocks]] diff --git a/org-cyf-itp/content/structuring-data/sprints/3/day-plan/index.md b/org-cyf-itp/content/structuring-data/sprints/3/day-plan/index.md index 5f26fd836..17fd56bef 100644 --- a/org-cyf-itp/content/structuring-data/sprints/3/day-plan/index.md +++ b/org-cyf-itp/content/structuring-data/sprints/3/day-plan/index.md @@ -19,8 +19,8 @@ time=65 name="Morning break" src="blocks/morning-break" [[blocks]] -name="Problem Solving Workshop" -src="https://codewars-workshops.codeyourfuture.io/problem-03/" +name = "Clean Code Workshop" +src = "https://github.com/CodeYourFuture/CYF-Workshops/tree/main/clean-code" time=60 [[blocks]] name="lunch" @@ -29,7 +29,7 @@ src="blocks/lunch" name="Stand Up" src="blocks/standup" time=15 -[[blocks]] +[[blocks]] name="Study Group" src="blocks/study-group" time=135 diff --git a/org-cyf-itp/content/structuring-data/sprints/3/prep/index.md b/org-cyf-itp/content/structuring-data/sprints/3/prep/index.md index 9846717b5..8dd52ba4f 100644 --- a/org-cyf-itp/content/structuring-data/sprints/3/prep/index.md +++ b/org-cyf-itp/content/structuring-data/sprints/3/prep/index.md @@ -28,6 +28,9 @@ name="First test case" src="module/js1/feedback" name="Interpreting feedback" [[blocks]] +name="Dead Code" +src="module/js1/dead-code" +[[blocks]] src="module/js1/generalise" name="Generalising further" [[blocks]] diff --git a/org-cyf-sdc/content/complexity/sprints/2/day-plan/index.md b/org-cyf-sdc/content/complexity/sprints/2/day-plan/index.md index fbe1f3333..e693beba4 100644 --- a/org-cyf-sdc/content/complexity/sprints/2/day-plan/index.md +++ b/org-cyf-sdc/content/complexity/sprints/2/day-plan/index.md @@ -13,9 +13,9 @@ time = "60" [[blocks]] name = "Morning break" src = "blocks/morning-break" -[[blocks]] +[[blocks]] name = "Clean Code Workshop" -src = "module/complexity/clean-code-workshop" +src = "https://github.com/CodeYourFuture/CYF-Workshops/tree/main/clean-code" time = "45" [[blocks]] name = "Study Group" diff --git a/org-cyf/README.md b/org-cyf/README.md index 128717f7d..4225cf547 100644 --- a/org-cyf/README.md +++ b/org-cyf/README.md @@ -38,4 +38,4 @@ In this curriculum you'll find the content that we teach at CodeYourFuture. For ## Contributing -Please read CONTRIBUTING.MD +Please read [CONTRIBUTING.md](../CONTRIBUTING.md)