Skip to content

Lab 3 updates #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
afeld merged 4 commits into from
Feb 4, 2026
+27 −33
Merged

Lab 3 updates #134

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6fd9659
Lab 3 formatting tweaks
afeld Feb 4, 2026
18b3f39
Project repositories are created for students
afeld Feb 4, 2026
9342eae
loosen instructions around repository cloning
afeld Feb 4, 2026
02e0341
project repo setup: add README and license
afeld Feb 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 27 additions & 33 deletions labs/lab_03.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,28 +20,22 @@ Students:

## [Project team](../docs/project.md#teams) repository setup

1. [Create a public repository in the `advanced-computing` organization.](https://github.com/new?owner=advanced-computing&visibility=public)
- Make the name something distinctive, such as:
- What your project is focused on
- Your celebrity couple name
- A combination of your favorite snacks
- The name your automation will assume once it becomes sentient
Copy link
Member Author

@afeld afeld Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Repository is now created for each team through Terraform, for consistency.

1. Using the terminal
1. `cd` to this directory
1. [Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) your project repository
1. Copy the repository URL
1. In the terminal run `git clone <URL>`
1. Open your local repository folder in VSCode
1. [Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) your project repository.
1. Open your local repository folder in VSCode.
1. Create a README that contains your [Proposal](../docs/project.md#proposal) (at a minimum).
1. [Choose a license](https://choosealicense.com/) for your repository.

---

## Adding a [`.gitignore`](https://docs.github.com/en/get-started/getting-started-with-git/ignoring-files#configuring-ignored-files-for-a-single-repository)

- In general, we don't want Git to commit every single file in our local repository
- Examples: **.DS_Store** files in macOS; **Thumbs.db** files in Windows; python environment files **.env** and **.venv** (more on this below)
- We can tell Git which files and folders to ignore using a .gitignore file
- In general, we don't want Git to commit every single file in our local repository. Examples:
- **.DS_Store** files in macOS
- **Thumbs.db** files in Windows
- Python environment files **.env** and **.venv** (more on this below)
- We can tell Git which files and folders to ignore using a `.gitignore` file
- [Set one up for Python and Mac or Windows](https://www.toptal.com/developers/gitignore?templates=macos,python)
- Save a .gitignore file in your repository's root directory
- Save a `.gitignore` file in your repository's root directory

---

Expand All @@ -67,29 +61,29 @@ Students:

---

## Checking that .gitignore works
## Checking that `.gitignore` works

- Check the list of changes in the Source Control panel of VSCode
- Go to the .gitignore file, comment the `.venv/` line and save
- Check the list of changes again. Can you see the problem?
- Uncomment the `.venv/` line and save
- Create a new branch, commit and push
- By group, merge one of the pull requests
1. Check the list of changes in the Source Control panel of VSCode.
1. Go to the `.gitignore` file, comment the `.venv/` line and save.
1. Check the list of changes again. Can you see the problem?
1. Uncomment the `.venv/` line and save.
1. Create a new branch, commit and push.
1. By group, merge one of the pull requests.

---

## Pull request practice

- Make sure your repository is up-to-date: `checkout` to the main branch and `pull`
- Each student will create a new branch to add a new feature:
- **Student A**: add the notebook from [Part 1](../docs/project.md#part-1)
- Ensure the notebook runs from VSCode.
- The notebook may not (fully) render on GitHub, due to having interactivity. Try accessing the GitHub URL via [nbviewer](https://nbviewer.org/)/[Colab](https://colab.research.google.com/).
- **Student B**: add a README.md
- Add project title and a short description
- Setup/usage instructions - these will change over time
- **Student A or B**: add an [Open in Colab button](https://openincolab.com/)
- Review each other's pull requests
1. Make sure your repository is up-to-date: `checkout` to the `main` branch and `pull`
1. Each student will create a new branch to add a new feature:
1. **Student A**: add the notebook from [Part 1](../docs/project.md#part-1)
- Ensure the notebook runs from VSCode.
- The notebook may not (fully) render on GitHub, due to having interactivity. Try accessing the GitHub URL via [nbviewer](https://nbviewer.org/)/[Colab](https://colab.research.google.com/).
1. **Student B**: add a `README.md`.
- Add project title and a short description
- Setup/usage instructions - these will change over time
1. **Student A or B**: add an [Open in Colab button](https://openincolab.com/)
1. Review each other's pull requests

---

Expand Down
Loading