notes with questions

Author: brownsarahm

_lab/lab10_checklist.md

@@ -0,0 +1,48 @@
+# Work time, Prepare, and more Explore Badge Ideas
+
+Today's lab is a couple of admin items and then time to work on 
+either a posted badge from this week or a related explore badge.  
+
+## Progress report
+
+Generate a progress report for yourself, either using your functional action that you worked on in lab before, or create an issue titled `Progress report request` by 2:15pm. 
+
+**I'll run a script that checks for issued with that title exactly, case sensitive at 2:15 and comment with a progress report**
+
+Once you have your progress report issue, comment on it and @ mention `brownsarahm` with your answer to the following: 
+- does everything look right?
+- is there anything you are waiting on?
+- what support do you need
+
+## Prepare for class next week
+
+ [install this hardware simulator](https://www.nand2tetris.org/software)
+
+## Bonus explore idea
+
+For the C experiment in 2023-11-07 practice badge, the goal for you to learn here is to see a practical example of how to modify code for use on a server. You can extend this to do something else with the server.  For example: 
+- compare the time the experiment takes on your laptop compared to seawulf
+- compare timing using a cloud service
+- Is the performance different if you put the loop in the C code vs in the bash script? 
+- Is there any performance difference in compiling on the login node before vs compiling in the compute node?
+- Do other style things you could think of impact the performance?
+
+tip see the man file for the bash command `time`
+
+
+## Lab checkout 
+
+Create `lab10.md` on a branch linked to this issue and answer the following 
+
+```
+1. What progress did you make today? 
+1. How well are you utilizing the support systems in this course (office hours, lab time, questions on issues)?
+```
+
+Create a PR with the following checklist to go over with a TA or me:
+
+```
+- [ ] can run hardware simulator
+- [ ] commented on progress report
+- [ ] has one new badge officially started (PR open, even if not complete)
+```

_lab/lab1_checklist.md

@@ -0,0 +1,70 @@
+# Setup
+
+## Lab Intro
+
+In lab each week, you will work at your own pace with the TAs and I around to help you.  Each week, at or right before the start of lab, I will post an issue on your repo with the lab activity. 
+
+For all of these steps, you can discuss with neighbors, but everyone must submit their own work. 
+
+## Setup 
+
+*each of the links in the following steps are to the documentation for how to do the step*
+
+- [ ] Merge the PR with template updates
+- [ ] [Create a project](https://docs.github.com/en/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project#creating-an-organization-project) for grade tracking
+- [ ] set the [visibility](https://docs.github.com/en/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects#changing-project-visibility) so that it is private
+- [ ] [link the project to your repo]([project](https://docs.github.com/en/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-repository))
+- [ ] make sure your experience report from yesterday is set up
+- [ ] make sure you have git installed locally (instructions in tools section of syllabus)
+
+
+## Syllabus Quiz
+
+Complete this [syllabus quiz](https://forms.gle/vJHyGJpGcLcNYL6K7). 
+
+You should definitely use the syllabus and you may talk with neighbors, but be sure to understand everything. 
+
+
+## Find your terminal
+
+On Mac you should use your native terminal app, but optionally switch to bash from zsh.  zsh will be the same in most cases, but occasionally different. 
+
+On Windows you should use GitBash (git for windows). 
+
+## Lab Reflection
+
+1. Create a [branch for this issue](https://docs.github.com/en/issues/planning-and-tracking-with-projects/managing-your-project/managing-visibility-of-your-projects#changing-project-visibility) **keep the default name**
+2. Create a file `lab1.md` on the new branch 
+3. Copy and fill in the template below to the `lab1.md` file
+
+```
+# Lab 1: Setup and Syllabus
+
+## Setup Notes
+
+<!-- make any notes or reminders for yourself about resources and setup for class, maybe link to your project board -->
+
+## Syllabus Notes
+
+<!-- is there anything you got wrong on the syllabus quiz that you have figured out and want to rephrase in your own words for yourself? -->
+
+
+```
+
+## Lab Checkout 
+
+1. Open a pull request for the branch linked to this issue
+2. Paste the following checklist in the PR body
+3. Confirm that the `lab1.md` file you created is visible in the diff
+4. Set the title of the PR to "Lab 2023-09-08"
+5. Review the checklist with a TA or Instructor
+6. When the checklist is complete, you can leave lab or continue working on your review or practice badge from yesterday
+
+
+```
+For Instructor/TA:
+- [ ] Project board exists
+- [ ] Experience badge is complete
+- [ ] Terminal ready for Tuesday
+- [ ] Syllabus quiz complete
+```

_lab/lab2_checklist.md

@@ -0,0 +1,52 @@
+# Get organized
+
+## Lab Intro
+
+In lab each week, you will work at your own pace with the TAs and I around to help you.  Each week, at or right before the start of lab, I will post an issue on your repo with the lab activity. 
+
+For all of these steps, you can discuss with neighbors, but everyone must submit their own work. 
+
+## Prepare to get credit for the lab
+
+1. Clone your KWL repo locally, make sure it is **not inside** of your `github-inclass-` repo but in the same folder as that.  As in if you do `ls` you would see both repos. 
+2. Create a branch for this issue
+3. Check the branch out locally
+4. Create a file called `lab2.md`
+
+
+## Getting Organized 
+
+1. Make sure that the [base role](https://docs.github.com/en/issues/planning-and-tracking-with-projects/managing-your-project/managing-access-to-your-projects#managing-access-for-everyone-in-your-organization) of your project board is "no access"
+2. [Bulk add](https://docs.github.com/en/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project#bulk-adding-issues-and-pull-requests) your current **issues** to your project board
+3. Customize what feilds are visible and look at the options for automation to make your project board helpful to you
+4. Set up [automatic adding](https://docs.github.com/en/issues/planning-and-tracking-with-projects/automating-your-project/adding-items-automatically#about-automatically-adding-items) for issues using the labels
+5. Make sure you can find it easily, however works best for you
+6. Add a section `# Organization` and make notes about how you set up your board in your `lab2.md` file
+
+
+## Manage what issues you get 
+
+You can only earn review **or** practice badge for each  date, so if both are there, you should expect to do one and close the other as "not planned". Alternatively you can edit the  action I use to post them so that only one is created.
+
+**this is your choice**
+
+To only get one
+1. Navigate to you your `.github/workflows/getassignment.yml` file in your kwl repo
+2. click the pencil to edit
+3. use the comments to identify the lines related to the badge type you do not want issues for 
+4. comment them out with a `#` or delete them
+5. commit the changes to a branch and request a review from @instructors
+
+
+**either way:** add a section `## issues` to your `lab2.md` and state what your plan is. 
+
+## Work on your badges
+
+the ones from yesterday are already in progress from doing some of the above steps! 
+
+## Lab checkout
+
+1. commit and push your work on the branch for this issue
+2. create the pull request
+3. show a TA or instructor your PR for approval
+4. show a TA or instructor that you have started a badge

_lab/lab3_checklist.md

@@ -0,0 +1,78 @@
+# Organize Files
+
+## Plan for success
+
+I want you to plan out what things you are going to do and to confirm that your planned work matches the grade you expect
+
+1. Create a a dedicated branch for this task, named `grade_plan`
+2. Fill in the `about.md` file in your KWL repo so I can know a little more about you. You can add extra sections or whatever you think will help me support you. 
+3. Answer the following in a a file called `plan.md`. 
+
+```
+# Plan for success
+
+__Target Grade:__ 
+
+## Plan to get there: 
+- x experience badges 
+- x lab checkouts
+- (other badges you plan)
+
+<!-- If you plan any build badges,uncomment the line below and list some ideas, topics from the course website your are curious about or questions you have. Also think about what timeline you could realistically achieve them on. This is nonbinding, but to start the conversation  -->
+<!--## Builds -->
+
+<!-- If you plan any explore badges, create a schedule and propose one topic for your first explore badge -->
+
+<!--## Explore -->
+```
+
+Request a review from @brownsarahm on this plan. I will give you feedback/help you start planning out your work as appropriate. If you need time to think about this before you want feedback, open the PR, but do not request the review yet.  
+
+## Learn a little about CodeSpaces
+
+[Codespaces](https://docs.github.com/en/codespaces/overview) are a virutal machine that you can use VSCode on in browser.  You only have VSCode access to this system, but VSCode with the terminal is a lot of power. 
+
+If VSCode is new to you, use their documentation of the [VSCode interface](https://code.visualstudio.com/docs/getstarted/userinterface) to get oriented to the different parts of the screen. 
+
+On a branch for this issue, create a file `lab3.md` and write a note to your future self describing what a codespace is. 
+
+## Moving Files practice 
+
+ 
+
+1. [accept this assignment to get a messy repo](https://classroom.github.com/a/kNCZE42i)
+2. work in a Codespace, by clicking the Codespace link in the README file of the repo created or using the Codespace tab on the Code menu (click the green Code button).
+3. Optionally, set a [theme](https://code.visualstudio.com/docs/getstarted/themes)
+4. Follow the instructions in the README file. 
+5. When you are done cleaning, use the terminal to commit and push your changes. 
+6. In the terminal, write the history to a file called `cleanuplog.txt` using a redirect and the `history` command. 
+7. Use the VSCode version control menu in the Codespace to commit and push these files. 
+
+
+**note that if you skip a commit message, it still opens a file for you to edit, but since you are in VSCode, it is as a file instead of with vim**
+
+## Badge Work
+
+1. Read the practice and review badges for yesterday's class. 
+2. Decide which you will do
+3. Start the badge by creating a branch for it and opening that branch in a codespace.
+4. Create the file 
+5. work more if time
+6. Commit and push
+   
+You'll have to finish the badge working locally because CodeSpaces only allow you to work with one repo at a time by default. 
+
+
+## Lab Checkout 
+
+1. Make a PR for the branch linked to this PR. 
+2. Use the checklist in the PR
+3. meet with a TA or Instructor
+
+```
+- [ ] lab3.md file exists in the PR
+- [ ] plan PR exists
+- [ ] messy repo work is committed
+- [ ] history file from messy repo
+
+```

_lab/lab4_checklist.md

@@ -0,0 +1,24 @@
+# Work and Self Reflection
+
+## Work on what you need
+
+Work on whatever badges feel most essential to you right now.  
+
+Look for ones that you are less certain and discuss with classmates, the TAs, and Dr. Brown how to complete those tasks. 
+
+
+## Self Reflection 
+
+Either locally or in a codespace, use `gh pr list` from the GitHub CLI to view your progress in the course. Use the [docs](https://cli.github.com/manual/gh_pr_list) for this command to be able to see all of your badge statuses. You may also find it helpful to use `gh issue list` to view what you have open. 
+
+On the branch for this issue, create `lab4.md` and answer the following questions:
+
+```
+- How many badges are complete and approved?
+- How many are awaiting revision?
+- How many are awaiting review?
+- Are your PRs titles such that it would be easy to calculate your grade with a script?
+```
+
+*if the answer to the last question is no, it is a good time to fix them*
+

_lab/lab5_checklist.md

@@ -0,0 +1,71 @@
+# Design a CLI tool 
+
+Today you will apply what we learned about the unix philosophy to *design*, but not implement, a command line tool. 
+
+Notes: 
+- **read through this whole issue before you start working**
+- You may work with a classmate on your design
+- Your reflection must be individual
+- There are some extra things in the notes that we did not get to in class yesterday that might be helpful
+- it is okay if you do not finish the whole design, just be sure to answer the reflection questions.
+- if you are motivated to actually build the tool you design today, you can submit a bulid badge proposal to do it. 
+
+## Decide what your tool will do
+
+Some ideas: 
+- calculate grade in class
+- manage a todo list
+- badge formatting checker (that would run in a GitHub Action)
+
+
+
+## Design Process
+
+Questions to consider in your design process: 
+- what information do you need
+- what calculations need to occur
+- what can be done with existing tools we have seen (you do not need to consider what can be done with any tool ever invented)
+
+Within your designed command line tool: 
+- what command(s) will you have?
+- what arguments (required inputs) will you have?
+- what option(s) (optional inputs) will you have? 
+- what utility functions would enable your tool to not have any duplicated code? 
+
+
+## Checkout
+
+Template for `lab5.md`:
+
+In the design section you can choose:
+- write what the help for your command(s) would look like
+- if programming syntax is helpful you can write function def/API lines with the parameters and plain english that describes the inputs
+- if you do not finish your design, you can put whatever notes about progress that you make
+
+```
+# Lab 5 
+
+<!-- one sentence/phrase about what your tool does -->
+
+<!-- collaborator if applicable -->
+
+## Use case
+
+<!-- write a bash line that shows how you would use your command with existing commands and pipes -->
+
+
+## Design
+
+
+
+
+
+## Reflection
+
+1. How did this exercise impact your understanding of the unix philosophy?
+1. How did this planning exercise compare to your past experiences with planning out code? 
+1. What is the most important thing you learned in this lab? 
+1. Would you recommend this lab activity be reused? (yes/no/or suggested changes are welcome)
+
+```
+