Merge branch 'main' of https://github.com/CMU-17-356/cmu-17-356.github.io

Author: Aditya Shrivastava

docs/_data/schedule.yaml

@@ -289,11 +289,11 @@
 - date: Tue Feb 04
   homework:
     deadline: 'February 11, 2025'
-    link: ''
-    name: 'HW3: Working with GitHub'
+    link: 'assignments/hw3-25'
+    name: 'HW3: GitHub Basics'
     numDays: 5
   lecture:
-    link: ''
+    link: 'https://github.com/CMU-17-356/cmu-17-356.github.io/raw/refs/heads/main/docs/assets/pdfs/Lecture7.pdf'
     name: 'Coding as a Team Part 1'
   reading:
     link: ''
@@ -325,11 +325,11 @@
 - date: Thu Feb 06
   homework:
     deadline: 'February 27, 2025'
-    link: ''
+    link: 'project/p1'
     name: 'P1: Project Specification'
     numDays: 15
   lecture:
-    link: ''
+    link: 'https://github.com/CMU-17-356/cmu-17-356.github.io/raw/refs/heads/main/docs/assets/pdfs/Lecture8.pdf'
     name: 'Coding as a Team Part 2'
   reading:
     link: ''
@@ -371,20 +371,20 @@
     link: ''
     name: ''
   recitation:
-    handout: ''
+    handout: 'recitations/reci5-testing'
     name: 'Unit testing'
     quiz: ''
     slides: ''
 
 - date: Tue Feb 11
   homework:
     deadline: 'February 18, 2025'
-    link: ''
+    link: 'assignments/hw4-25'
     name: 'HW4: Testing'
     numDays: 5
   lecture:
-    link: ''
-    name: 'Testing'
+    link: 'https://github.com/CMU-17-356/cmu-17-356.github.io/raw/refs/heads/main/docs/assets/pdfs/Lecture9.pdf'
+    name: 'Code Review'
   reading:
     link: ''
     name: ''
@@ -420,7 +420,7 @@
     numDays: 0
   lecture:
     link: ''
-    name: 'Test Automation and CI/CD'
+    name: 'Testing'
   reading:
     link: ''
     name: ''

docs/_data/this_week.yaml

@@ -1,28 +1,28 @@
 last_homework:
   date: ""
-  deadline: "Tues Feb 4 @ 11:59pm"
+  deadline: "Tues Feb 11 @ 11:59pm"
   link: ""
-  name: "P0: Team Contracts"
+  name: "HW3: Working with Github"
   numDays: 1
 
 lectures:
-  - date: Tue Feb 4
+  - date: Tue Feb 11
     link: ""
-    name: "Coding as a Team Part 1"
-  - date: Thu Feb 6
+    name: "Testing"
+  - date: Thu Feb 13
     link: ""
-    name: "Coding as a Team Part 2"
+    name: "Test Automation and CI/CD"
 
 next_homework:
   date: ""
-  deadline: "Tue Feb 11 @ 11:59pm"
+  deadline: "Tue Feb 18 @ 11:59pm"
   link: ""
-  name: "HW3: Working with Github"
+  name: "HW4: Testing"
   numDays: 5
 
 recitation:
-  date: Fri Feb 7
+  date: Fri Feb 14
   handout: ""
-  name: "Github Basics"
+  name: "Unit Testing"
   quiz: ""
   slides: ""

docs/assets/pdfs/Lecture7.pdf

@@ -1,39 +1,40 @@
-# Homework 3: Github basics
+# Homework 3: GitHub Basics
 
 ## Learning goals
 
-- Get comfortable with Github if you aren't already
+- Get comfortable with GitHub if you aren't already
 - Think about secure development practices
 - Practice simple code review
 
 ## Project context
 
-You and your team have access to a basic calculator app through Github classroom. Over the next three assignments, you'll (1) set up the repo and merge a few simple PRs (2) deploy the application and set up automated deployments and (3) write tests and create a continuous integration (CI) pipeline. **You should apply the development processes you learn here to your prototype product.**
+You and your team have access to a basic calculator app through GitHub classroom. Over the next three assignments, you'll (1) set up the repo and merge a few simple PRs (2) deploy the application and set up automated deployments and (3) write tests and create a continuous integration (CI) pipeline. **You should apply the development processes you learn here to your prototype product.**
 
 ## Assignment instructions
 
 In this assignment, you'll set up your local development environment, securely configure your repo, make a PR, and review your teammates' PRs.
 
 You'll notice that a number of these steps address *security operations*. Why bother with a secure setup? Well, if you actually build a successful company, you (and your software!) become a target. If an attacker can gain write access to your source code, for example, they can insert backdoors that let them hold services ransom, steal user data, or even steal money. This opens you up to a world of legal and financial pain---but luckily, there are really simple things you can do that significantly raise the barrier for attackers. This assignment touches on several of them. 
 
-### 1. Configure Github with (non-SMS) 2FA
+### 1. Configure GitHub with (non-SMS) 2FA
 
-Having a 2FA method makes it vastly harder for attackers to compromise your Github account and impersonate you.
+Having a 2FA method makes it vastly harder for attackers to compromise your GitHub account and impersonate you.
 
-Follow [these instructions](https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication) to set up two-factor authentication for your Github account. **This 2FA method must not be text message/SMS**. We reccomend [FIDO](https://fidoalliance.org/specs/u2f-specs-master/fido-u2f-overview.html) if possible, and [TOTP](https://datatracker.ietf.org/doc/html/rfc6238) as a backup option.
+Follow [these instructions](https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication) to set up two-factor authentication for your GitHub account. **This 2FA method must not be text message/SMS**. We reccomend [FIDO](https://fidoalliance.org/specs/u2f-specs-master/fido-u2f-overview.html) if possible, and [TOTP](https://datatracker.ietf.org/doc/html/rfc6238) as a backup option.
 
 #### Turn in instructions
 
-When you have done so, navigate to your Github profile; under Settings and Authentication, take a screenshot of the Preferred 2FA Method box that includes both the 2FA method and your username. Do not include anything else in the screenshot (this is possible due to the layout of the page).
+When you have done so, navigate to your GitHub profile; under Settings and Authentication, take a screenshot of the Preferred 2FA Method box that includes both the 2FA method and your username. Do not include anything else in the screenshot (this is possible due to the layout of the page).
 
-### 2. Configure Github with SSH
+### 2. Configure GitHub with SSH
 
-Using SSH for Github authentication is both more secure and more convenient than using password authentication.
+Using SSH for GitHub authentication is both more secure and more convenient than using password authentication.
 
-Follow [these instructions](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/about-ssh) to set up a new SSH key with Github if you haven't already. Specifically, you will:
-- [Generate a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent). Make sure to [use a passphrase](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases).
-- [Add the SSH key to your account](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account).
-- [Test that everything worked](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection).
+Follow [these instructions](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/about-ssh) to set up a new SSH key with GitHub if you haven't already. Specifically, you will:
+
+1. [Generate a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent). Make sure to [use a passphrase](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases).
+2. [Add the SSH key to your account](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account).
+3. [Test that everything worked](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection).
 
 #### Turn in instructions
 
@@ -47,13 +48,21 @@ To get ten bonus points, [configure commit signing](https://docs.github.com/en/a
 
 Submit a screenshot of your signed commits and your description.
 
-### 3. Clone the calculator repo onto your local machine
+### 3. Create your GitHub classroom team.
+
+One person on your team should go to this [GitHub Classroom](https://classroom.github.com/a/2g4EHsgQ) link to create your team. Be sure to select all of your team's members. Check to see if your team name already exists in the Software Engineering for Startups organization before creating a new one.
 
-When you navigate to the Code tabe, make sure you use the SSH tab, not the HTTPS tab. This will clone the repo using the SSH authentication flow.
+This will create a shared repository for all members of your team. All of the instructors will have admin access to your new repository.
 
 **There is no deliverable for this step.**
 
-### 4. Configure branch protection
+### 4. Clone the calculator repo onto your local machine
+
+When you navigate to the Code tab, make sure you use the SSH tab, not the HTTPS tab. This will clone the repo using the SSH authentication flow.
+
+**There is no deliverable for this step.**
+
+### 5. Configure branch protection
 
 As it stands, anyone with access to your repo can push whatever garbage they want to the main branch. That's not good! It's important to make sure code that actually gets deployed has been thoroughly tested and reviewed (to catch everything from mistakes to intentional back doors!). In this assignment, you'll focus on code review; in a future assignment, you'll block merges to main until your code passes CI.
 
@@ -63,7 +72,7 @@ To protect your main branch, navigate to the Settings tab in the calculator repo
 
 Take a screenshot of your branch protection rules; we'll also check the repository directly. 
 
-### 5. Configure pull requests
+### 6. Configure pull requests
 
 Your main history is much easier to track if all commits to main are uniform. Different teams have different preferences for this configuration, but in this class, we'll require [squash merging](https://learn.microsoft.com/en-us/azure/devops/repos/git/merging-with-squash?view=azure-devops) for a clean history; this is a very common configuration.
 
@@ -73,37 +82,38 @@ Navigate to the General settings. Under Pull requests, uncheck merge commits and
 
 Take a screenshot of your repo's PR settings.
 
-### 6. Run the calculator app locally
+### 7. Run the calculator app locally
 Follow the instructions in the **README** to set up and run the calculator on your machine. You can choose to deploy the app locally using either Docker or npm, depending on your preference. Ensure everything is working before proceeding with any modifications.
 
 **There is no deliverable for this step.**
 
-### 7. Add a piece of functionality to the calculator
+### 8. Add a piece of functionality to the calculator
 
 You will add a new piece of calculator functionality [*in a new branch*](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging). Then, you will [open a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request?tool=webui) (PR) so that your teammates can review and approve your changes. 
 
-Choose one of the following functionality: (Coordinate with your teammates to ensure no two members implement the same functionality.)
-1. **Backward Button**: Add a button that allows users to remove the last entered character in the calculator input field.
-2. **Custom Pop-up for Invalid Expressions**: Display a pop-up window when the user enters an invalid expression.
-3. **Brackets Support**: Add "(" and ")" buttons and ensure expressions with brackets are correctly handled.
-4. **Expression History Display**: Show a list of previously calculated expressions in the frontend. The list should reset when the browser is refreshed.
-5. **Backend Logging**: Log all expressions sent to the backend into a local file. The log should persist even after the browser is refreshed.
+Each team member should choose one of the following features. Coordinate with your teammates to ensure no two members implement the same functionality.
+
+  1. **Backward Button**: Add a button that allows users to remove the last entered character in the calculator input field.
+  1. **Custom Pop-up for Invalid Expressions**: Display a pop-up window when the user enters an invalid expression.
+  1. **Brackets Support**: Add "(" and ")" buttons and ensure expressions with brackets are correctly handled.
+  1. **Expression History Display**: Show a list of previously calculated expressions in the frontend. The list should reset when the browser is refreshed.
+  1. **Backend Logging**: Log all expressions sent to the backend into a local file. The log should persist even after the browser is refreshed.
 
 Use your PR message to clearly describe the changes you've made to the calculator app.
 
 #### Turn in instructions
 
 Please provide us a link to your PR.
 
-### 8. Review at least two PRs
+### 9. Review at least two PRs
 
 Following the best practices we discussed in class, leave two reviews on your teammates' PRs. If there issues, continue to discuss in the comments until you're satisfied with the changes and able to approve the pull requests.
 
 #### Turn in instructions
 
 Please provide two or more links to your reviews. 
 
-### 9. Merge your reviewed PR
+### 10. Merge your reviewed PR
 
 Finally, once your PR has been approved, [merge it](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request).