From 4275413680abe4a804f2ee4ced5fee55521d5311 Mon Sep 17 00:00:00 2001 From: Anastasiia <109740924+anastasiiauk@users.noreply.github.com> Date: Thu, 26 Jun 2025 17:23:49 +0300 Subject: [PATCH] feat(curriculum): add review tasks to block 19 of the A2 curriculum (#61016) --- .../65e8697e64f1883a30a759e5.md | 212 +++--------------- .../65e93be2cbc1da18d7602a31.md | 170 +++----------- .../65e99a2986903b5c9f4bc720.md | 199 +++------------- 3 files changed, 95 insertions(+), 486 deletions(-) diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-document-code-for-a-project/65e8697e64f1883a30a759e5.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-document-code-for-a-project/65e8697e64f1883a30a759e5.md index 1af1b890062..b34d95a121f 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-document-code-for-a-project/65e8697e64f1883a30a759e5.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-document-code-for-a-project/65e8697e64f1883a30a759e5.md @@ -5,49 +5,47 @@ challengeType: 22 dashedName: task-23 --- - + # --description-- -Listen to the audio and complete the sentence. +This is a review of the entire dialogue you just studied. + +# --instructions-- + +Place the following phrases in the correct spot: + +`README file`, `run the code`, `conventions`, `assigned to`, `setup instructions`, and `dependencies`. # --fillInTheBlank-- ## --sentence-- -`Sophie has been BLANK to work on a project and needs to know how to BLANK the code. Brian suggests creating a README file in the BLANK BLANK, listing BLANK, specifying how to BLANK the code, and mentioning the coding BLANK they BLANK. Sophie thanks Brian and will BLANK sure she follows his BLANK.` +`Sophie: Hey, Brian, I've been BLANK work on this project, and I'm not sure where to start. Could you help me understand how we should document the code?` + +`Brian: Of course. The first thing you should do is create a clear BLANK that's in the project's root directory. This file should contain information about the project, its purpose, and how to set it up.` + +`Sophie: Got it. What else should I include in my README?` + +`Brian: You should list the project BLANK so that anyone who wants to work on it knows what they need. Then specify how to BLANK and any other essential BLANK. Also, mention coding BLANK we follow in this project.` + +`Sophie: Thanks, I'll make sure to follow your instructions.` ## --blanks-- -`assigned` +`assigned to` ### --feedback-- -Sophie mentions she's been assigned, meaning given a specific task, to the project. +Given a task or responsibility to do. --- -`document` +`README file` ### --feedback-- -It refers to writing down important information about how the code works. - ---- - -`root` - -### --feedback-- - -It refers to the main or primary directory in a project where the README file should be placed. - ---- - -`directory` - -### --feedback-- - -It is the folder or location in the project where files are stored. +A file that gives important information about a project, like how to use it. --- @@ -55,15 +53,23 @@ It is the folder or location in the project where files are stored. ### --feedback-- -These are the necessary components or resources needed for the project. +Other software or tools your project needs to work. --- -`run` +`run the code` ### --feedback-- -`To run` the code means to execute or start it. +To start a program and see what it does. + +--- + +`setup instructions` + +### --feedback-- + +Steps you follow to prepare a program or project so it works. --- @@ -71,156 +77,4 @@ These are the necessary components or resources needed for the project. ### --feedback-- -These are the standard or agreed ways of writing code in the project. - ---- - -`follow` - -### --feedback-- - -It means to adhere to or go along with the given guidance. - ---- - -`make` - -### --feedback-- - -In this context, it is about ensuring or seeing to it that something is done. - ---- - -`instructions` - -### --feedback-- - -These are the directions or guidance provided by Brian. - -# --scene-- - -```json -{ - "setup": { - "background": "company2-center.png", - "characters": [ - { - "character": "Sophie", - "position": { "x": -25, "y": 0, "z": 1 } - }, - { - "character": "Brian", - "position": { "x": 125, "y": 0, "z": 1 } - } - ], - "audio": { - "filename": "7.1-1.mp3", - "startTime": 1 - }, - "alwaysShowDialogue": true - }, - "commands": [ - { - "character": "Sophie", - "position": { "x": 25, "y": 0, "z": 1 }, - "startTime": 0 - }, - { - "character": "Brian", - "position": { "x": 70, "y": 0, "z": 1 }, - "startTime": 0.5 - }, - { - "character": "Sophie", - "startTime": 1, - "finishTime": 4.94, - "dialogue": { - "text": "Hey, Brian, I've been assigned to work on this project, and I'm not sure where to start.", - "align": "left" - } - }, - { - "character": "Sophie", - "startTime": 5.48, - "finishTime": 7.94, - "dialogue": { - "text": "Could you help me understand how we should document the code?", - "align": "left" - } - }, - { - "character": "Brian", - "startTime": 8.5, - "finishTime": 13.96, - "dialogue": { - "text": "Of course. The first thing you should do is create a clear README file that's in the project's root directory.", - "align": "right" - } - }, - { - "character": "Brian", - "startTime": 14.5, - "finishTime": 19.3, - "dialogue": { - "text": "This file should contain information about the project, its purpose, and how to set it up.", - "align": "right" - } - }, - { - "character": "Sophie", - "startTime": 19.72, - "finishTime": 21.8, - "dialogue": { - "text": "Got it. What else should I include in my README?", - "align": "left" - } - }, - { - "character": "Brian", - "startTime": 22.22, - "finishTime": 27.38, - "dialogue": { - "text": "You should list the project dependencies so that anyone who wants to work on it knows what they need.", - "align": "right" - } - }, - { - "character": "Brian", - "startTime": 27.38, - "finishTime": 31.96, - "dialogue": { - "text": "Then specify how to run the code and any other essential setup instructions.", - "align": "right" - } - }, - { - "character": "Brian", - "startTime": 33.04, - "finishTime": 35.96, - "dialogue": { - "text": "Also, mention coding conventions we follow in this project.", - "align": "right" - } - }, - { - "character": "Sophie", - "startTime": 36.92, - "finishTime": 38.78, - "dialogue": { - "text": "Thanks, I'll make sure to follow your instructions.", - "align": "left" - } - }, - { - "character": "Brian", - "position": { "x": 125, "y": 0, "z": 1 }, - "startTime": 39.28 - }, - { - "character": "Sophie", - "position": { "x": -25, "y": 0, "z": 1 }, - "startTime": 39.78 - } - ] -} -``` +Common rules or ways of doing things in coding or a project. diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-document-code-for-a-project/65e93be2cbc1da18d7602a31.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-document-code-for-a-project/65e93be2cbc1da18d7602a31.md index 63db12aa0c4..86c830153f0 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-document-code-for-a-project/65e93be2cbc1da18d7602a31.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-document-code-for-a-project/65e93be2cbc1da18d7602a31.md @@ -5,17 +5,31 @@ challengeType: 22 dashedName: task-35 --- - + # --description-- -Listen to the audio and complete the sentence. +This is a review of the entire dialogue you just studied. + +# --instructions-- + +Place the following phrases in the correct spot: + +`comments`, `clarify`, `comment on`, `describe`, `double slashes`, and `parts of`. # --fillInTheBlank-- ## --sentence-- -`Sophie is working on code and thinks adding BLANK is a good idea. Brian agrees and explains to use double slashes to start a comment. He suggests commenting on BLANK or tricky parts, explaining what BLANK do, and clarifying the purpose of BLANK. Sophie BLANK Brian's help and decides to start BLANK comments to the code.` +`Sophie: I'm working on this code and I think it's a good idea to add BLANK. How should I write comments in the code?` + +`Brian: Great idea. To write comments, you simply need to use BLANK to start a comment. Then, you can BLANK what the code does so that other people can understand it, too.` + +`Sophie: And what should I BLANK? Are there any specific things I should focus on?` + +`Brian: You should comment on any complex or tricky BLANK your code. You can also explain what certain functions do and BLANK the purpose of variables. Try to ensure that your comments are clear and concise.` + +`Sophie: I appreciate your help. I'll start adding comments to the code.` ## --blanks-- @@ -23,172 +37,44 @@ Listen to the audio and complete the sentence. ### --feedback-- -These are notes in code that explain what it does. This is what Sophie wants to add. +Notes in the code that explain what it does. The computer skips them. --- -`complex` +`double slashes` ### --feedback-- -Brian advises focusing on more difficult or complicated parts of the code. +Typing `//` starts a comment in many programming languages. --- -`functions` +`describe` ### --feedback-- -It means parts of code that perform specific tasks. Brian suggests explaining these in comments. +To explain what something is or what it does. --- -`variables` +`comment on` ### --feedback-- -These parts store values in code. Brian talks about clarifying their purpose in comments. +To write a note or give your opinion about something. --- -`appreciates` +`parts of` ### --feedback-- -It means being thankful for Brian's advice and guidance on commenting. +Different sections or pieces of something. --- -`adding` +`clarify` ### --feedback-- -It means putting comments into the code. - -# --scene-- - -```json -{ - "setup": { - "background": "company2-center.png", - "characters": [ - { - "character": "Sophie", - "position": { "x": -25, "y": 0, "z": 1 } - }, - { - "character": "Brian", - "position": { "x": 125, "y": 0, "z": 1 } - } - ], - "audio": { - "filename": "7.1-2.mp3", - "startTime": 1 - }, - "alwaysShowDialogue": true - }, - "commands": [ - { - "character": "Sophie", - "position": { "x": 25, "y": 0, "z": 1 }, - "startTime": 0 - }, - { - "character": "Brian", - "position": { "x": 70, "y": 0, "z": 1 }, - "startTime": 0.5 - }, - { - "character": "Sophie", - "startTime": 1, - "finishTime": 4.82, - "dialogue": { - "text": "I'm working on this code and I think it's a good idea to add comments.", - "align": "left" - } - }, - { - "character": "Sophie", - "startTime": 5.22, - "finishTime": 6.9, - "dialogue": { - "text": "How should I write comments in the code?", - "align": "left" - } - }, - { - "character": "Brian", - "startTime": 7.44, - "finishTime": 12.36, - "dialogue": { - "text": "Great idea. To write comments, you simply need to use double slashes to start a comment.", - "align": "right" - } - }, - { - "character": "Brian", - "startTime": 12.98, - "finishTime": 17.56, - "dialogue": { - "text": "Then, you can describe what the code does so that other people can understand it, too.", - "align": "right" - } - }, - { - "character": "Sophie", - "startTime": 18.36, - "finishTime": 21.94, - "dialogue": { - "text": "And what should I comment on? Are there any specific things I should focus on?", - "align": "left" - } - }, - { - "character": "Brian", - "startTime": 22.34, - "finishTime": 26.24, - "dialogue": { - "text": "You should comment on any complex or tricky parts of your code.", - "align": "right" - } - }, - { - "character": "Brian", - "startTime": 26.24, - "finishTime": 30.92, - "dialogue": { - "text": "You can also explain what certain functions do and clarify the purpose of variables.", - "align": "right" - } - }, - { - "character": "Brian", - "startTime": 31.36, - "finishTime": 34.82, - "dialogue": { - "text": "Try to ensure that your comments are clear and concise.", - "align": "right" - } - }, - { - "character": "Sophie", - "startTime": 35.66, - "finishTime": 38.3, - "dialogue": { - "text": "I appreciate your help. I'll start adding comments to the code.", - "align": "left" - } - }, - { - "character": "Brian", - "position": { "x": 125, "y": 0, "z": 1 }, - "startTime": 38.8 - }, - { - "character": "Sophie", - "position": { "x": -25, "y": 0, "z": 1 }, - "startTime": 39.3 - } - ] -} -``` +To make something easier to understand. diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-document-code-for-a-project/65e99a2986903b5c9f4bc720.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-document-code-for-a-project/65e99a2986903b5c9f4bc720.md index 3b7adbd6996..e83e2dc0d58 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-document-code-for-a-project/65e99a2986903b5c9f4bc720.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-document-code-for-a-project/65e99a2986903b5c9f4bc720.md @@ -5,25 +5,47 @@ challengeType: 22 dashedName: task-48 --- - + # --description-- -Listen to the audio and complete the sentence. +This is a review of the entire dialogue you just studied. + +# --instructions-- + +Place the following phrases in the correct spot: + +`commit message`, `code changes`, `descriptive`, `clarification`, `reference`, `version control`, and `description`. # --fillInTheBlank-- ## --sentence-- -`Sophie learns they're using Git for version control and asks how to BLANK code changes. Brian advises using BLANK commit messages, starting with an BLANK verb like "Fix" or "Add", followed by a BLANK description. He also says she should BLANK issues in commit messages when related to an BLANK. Sophie thanks Brian for the BLANK and says she will BLANK these steps.` +`Sophie: I see that we're using Git for BLANK. How do I document BLANK when I make updates or fixes?` + +`Brian: Good question. When you make changes, you should use BLANK commit messages. Start your message with a verb in the imperative form, like fix, add, or update, followed by a brief BLANK of what you did.` + +`Sophie: That sounds straightforward. Anything else I should keep in mind?` + +`Brian: You should also BLANK issues in your BLANK if you're working on a task related to an issue. It helps in tracking progress and understanding the context of changes.` + +`Sophie: Thanks for the BLANK. I'll make sure to follow these steps.` ## --blanks-- -`document` +`version control` ### --feedback-- -It refers to recording or noting down the changes made in the code. +A system that helps track and manage changes to code over time. + +--- + +`code changes` + +### --feedback-- + +Updates or edits made to a program's code. --- @@ -31,23 +53,15 @@ It refers to recording or noting down the changes made in the code. ### --feedback-- -It means providing enough detail to clearly convey the purpose of the changes. +Gives clear and detailed information. --- -`imperative` +`description` ### --feedback-- -This form is used for giving direct commands or instructions in the commit messages. - ---- - -`brief` - -### --feedback-- - -It means short and concise, keeping the commit message to the point. +Words that explain what something is or what it does. --- @@ -55,15 +69,15 @@ It means short and concise, keeping the commit message to the point. ### --feedback-- -It means to mention or point to, especially issues related to the task. +Something you use to find information or check details. --- -`issue` +`commit message` ### --feedback-- -This word in this context refers to a problem or topic being addressed in the code. +A short text explaining what changes were made to the code. --- @@ -71,149 +85,4 @@ This word in this context refers to a problem or topic being addressed in the co ### --feedback-- -It is the explanation or information that makes something clear or understandable. - ---- - -`follow` - -### --feedback-- - -It means to adhere to or go along with the advised steps. - -# --scene-- - -```json -{ - "setup": { - "background": "company2-center.png", - "characters": [ - { - "character": "Sophie", - "position": { "x": -25, "y": 0, "z": 1 } - }, - { - "character": "Brian", - "position": { "x": 125, "y": 0, "z": 1 } - } - ], - "audio": { - "filename": "7.1-3.mp3", - "startTime": 1 - }, - "alwaysShowDialogue": true - }, - "commands": [ - { - "character": "Sophie", - "position": { "x": 25, "y": 0, "z": 1 }, - "startTime": 0 - }, - { - "character": "Brian", - "position": { "x": 70, "y": 0, "z": 1 }, - "startTime": 0.5 - }, - { - "character": "Sophie", - "startTime": 1, - "finishTime": 3.4, - "dialogue": { - "text": "I see that we're using Git for version control.", - "align": "left" - } - }, - { - "character": "Sophie", - "startTime": 3.92, - "finishTime": 6.9, - "dialogue": { - "text": "How do I document code changes when I make updates or fixes?", - "align": "left" - } - }, - { - "character": "Brian", - "startTime": 7.6, - "finishTime": 12, - "dialogue": { - "text": "Good question. When you make changes, you should use descriptive commit messages.", - "align": "right" - } - }, - { - "character": "Brian", - "startTime": 12.44, - "finishTime": 15.1, - "dialogue": { - "text": "Start your message with a verb in the imperative form", - "align": "right" - } - }, - { - "character": "Brian", - "startTime": 15.1, - "finishTime": 20.7, - "dialogue": { - "text": "like fix, add, or update followed by a brief description of what you did.", - "align": "right" - } - }, - { - "character": "Sophie", - "startTime": 21.14, - "finishTime": 23.92, - "dialogue": { - "text": "That sounds straightforward. Anything else I should keep in mind?", - "align": "left" - } - }, - { - "character": "Brian", - "startTime": 24.32, - "finishTime": 27.12, - "dialogue": { - "text": "You should also reference issues in your commit message", - "align": "right" - } - }, - { - "character": "Brian", - "startTime": 27.12, - "finishTime": 29.44, - "dialogue": { - "text": "if you're working on a task related to an issue.", - "align": "right" - } - }, - { - "character": "Brian", - "startTime": 29.88, - "finishTime": 33.67, - "dialogue": { - "text": "It helps in tracking progress and understanding the context of changes.", - "align": "right" - } - }, - { - "character": "Sophie", - "startTime": 34.28, - "finishTime": 37.1, - "dialogue": { - "text": "Thanks for the clarification. I'll make sure to follow these steps.", - "align": "left" - } - }, - { - "character": "Brian", - "position": { "x": 125, "y": 0, "z": 1 }, - "startTime": 37.6 - }, - { - "character": "Sophie", - "position": { "x": -25, "y": 0, "z": 1 }, - "startTime": 38.1 - } - ] -} -``` +Extra information to make something easier to understand.