kevinaangstadt/cs340-s23-notes

Lecture Notes from CS-340 Spring 2023

CS340-S23-Notes

Lecture Notes from CS-340 Spring 2023

cs340-s23-notes's Issues

Waiting for PR #129 to fix PR #109

My pull request has an additional pull request for some contribution to day21 notes but cannot be changed or made into separate pull req until the fixed PR129 goes through.

Lecture 5 Outline

Now that PR's are being added to the main branch it would be helpful if we could figure out a general format for all of the lecture notes to fit into and what general content is going to be consistent across all of the lecture summaries.

branching from main

It is important that we create new branches in order for us to make changes to the main. It on GitHub there is an option to create new branch then we can checkout this branch to make changes. Should we format our commits in a specific way in order for them to be more readable? My proposal would be the day we were assigned to and then then our name.

Outline formatting proposal

Within my pull request I have an outline for my lecture with a sample lecture. I think this may help solve the issue for finding a good format.

Within the format I have headings, sub heading, and important things to note bolded/italicized. I also used lines to separate different ideas which are made with "---" in one line of the markdown file.

Lastly, I added definitions within the file.

For example:
"term
:definition"

Problem with lecture notes 26

The folder is located within the main branch.

It seems that whoever is recording the notes for lecture 26 which is April 24th is within its own folder.
Im not sure if we want to separate it out into folders within the repo to make everything more specific or not.
We should come to a consensus on this soon because the project is due in about a week.

Unpopulated Day 6 Notes

I have added an empty markdown file to store day 6 notes. This outline will need to be populated in the future once a style for the formatting has been chosen.

Lecture notes Header Style

Is there a way we can come in agreement on having similar header style for our notes, so, all of our lecture notes will have a consistent header style format.

Style_Guide

Hey everyone,

It would probably be a good idea if we could all agree on a universal style sheet for our lecture notes.

Things to consider could be :

• Font style
• Font size
• Headers
• If we should include our name at the top
• Title inside the document that outlines the topics covered
• Spacing

The style guide hasn't been claimed by anyone yet, so maybe a few of us should get together and sort this out before people start submitting notes.

Last call for style guide suggestions

I will be finishing up the style guide in the next few days. If you have any final suggestions please post them as an issue if you would like them to be considered for the style guide.

marking important information

is there a way that we should mark important information that has either been said to likely be on an exam or just needed later? Should we just have a section stating that this is the most important/useful? Also, should we mark down things for who ever ends up doing the second exam review to put in said review?

Merge Issue

This might be an issue for others too, check if the Day 9 branch is merged with the lecture notes. This happened to me where they both merged.

Clarification about branches

I have noticed some a few different branches being used to submit PRs, and wanted to clarify some things so we are all on the same page. The project description says:
"Create your pull requests from non-main branches. That is, create a new branch with a descriptive name before committing your
contributions to your fork."
So those who submitted from the main branch will want to create a new branch for their final submit.

Also, I wonder if we should all use the same naming scheme for our branches? I'm not sure if this will make a difference to the end result so let me know what y'all think about this.

Empty Lecture 14 Notes

I have added an empty outline as a markdown file for the lecture 14 notes. This file will be filled out with the notes for lecture 14 at a later date.

Including homework readings

If we include homework readings, should it be readings assigned during your lecture day, or the reading due on your lecture. For mine at least it makes more sense for the former, but what do you all think?

Lecture notes for Day15 file type

I am wondering if it is possible to submit the lecture notes as a pdf just because I mostly take down notes on my ipad and this also makes it easy when it comes to drawing diagrams. My handwriting is legible and hence do we only need to have them typed?

Extraneous Lecture_Notes_3_29_23 file needs to be removed

I noticed that the Lecture_Notes_3_29_23.md file appears to be an initial contribution for day 19 notes (according to the spreadsheet in #26). I also notice that we appear to have a completed version of our Day19Notes.md merged into our main branch. There was likely some issue during PR #104.

@pamaph20, we were both working with this PR earlier. Can you check my work here?

If this is the case, removing Lecture_Notes_3_29_23.md from our main repository could be an opportunity for someone to get in another PR

More on Formatting Style

Along with the formatting guidelines that we decide on, I think that it is important to utilize bolding and italicizing certain words or key concepts. Doing so is quite easy in markdown files to bold a word, simply insert "**" before and after the word or sentence. Italicizing is inserting "*" before and after the word or the sentence.

Style Guide Formatting

Within the style guide (#116) it states to have all major sections of notes separated out with horizontal lines ->
"Major sections should be separated by horizontal rules"
However, there are some instances where we define major aspects of a process but do not go into depth about it. Without the in depth portion the maintaining of the horizontal rules makes the markdown file feel clunky (Reference down below) . How would we go about this to make the file look more presentable.

4) something here

stuff

• more stuff
• things

---

5) Another subsection

---

6) Another section

(See also Markdown Guide - Horizontal Rules)

Clarifying Questions in each others notes

Hello Everyone! I was wondering how we plan on tackling this if we find that one of our peer's outlines might need more clarification or examples.

Linking in Markdown

As the style guide suggests, we should link necessary outside material used in class, as certain classes do link outside materials within the lecture.
Just wanted to let everyone know if they weren't aware, there is a cool & quite easy way to make hyperlinks in markdown so that it isn't just the entire link within the notes, but a link embedded into other text. You can use this syntax:
https://anvilproject.org/guides/content/creating-links
Just thought it looked nice and seemed useful for making clean lecture notes.

Missing content

is there a way if we Identify any important content that is missing from the lecture notes, like if a topic was covered in class but is not mentioned in the notes. we can mark down that to be added

Naming Format for Class 3/27/23

The file naming format for 3/27/23 does not contain the lecture number or follow the guidelines for naming. File name needs to be updated to match proper format.

Naming Format

We need to determine the correct naming convention for the lecture notes.
Most of the files are under lecture__.md (number) but the style guide recommends Day__Notes.md.
Are there any opinions on what we should do for this problem?

Matching Style Guide Specs and chance for PR of contributions (P2 specs)

It looks like the style guide is now up and is waiting to be accepted from PR's (#116). With this now up, all class notes already up should be updated and formatted to match this. I think the sooner people update their daily notes the sooner people can review them to make sure they're correct before finals.

Additionally updating file notes to the proper format could be a good chance for people to do a PR of a contribution to someone else's document which is required for the P2 grading.

Graphics in Notes

After looking back in my notes, I noticed that there are some lectures that contain diagrams in the notes that are helpful to know. However, I don't know how we would go about implementing these diagrams into our notes, because we would not be able to imbed the image directly into the notes file. Does anyone have any suggestions on how we can include these diagrams, or would it be for the best to just ignore them?

Style Guide Deadline

Hey everyone,

Seeing as it has been some weeks and we have not decided on a the style for our notes, maybe we should set a deadline for that so we can move further along with the project.

Maybe we could have this done before our next exam on 04/26?

Let me know what you think ?

Filling in Lecture 1 Notes

I submitted a pull request for branch lecture1, which I created for the first day of lecture notes. lecture1.md contains an outline for the first day of lecture notes, but needs to be filled in by the p2 deadline.

When to add into lecture notes folder.

At what point should we be adding out lecture notes into the lecture notes folder. Furthermore, within our own repo is there any point in which we should merge our off_main branches with our main branch??

Question about merging and pull requests.

Should we be merging all the changes from main into our branches before committing?
Basically what I'm wondering is if the branch I create the pull request for only has my Day26Notes.md file in it, will this cause other files to be removed from main if my PR is accepted?

Pull Requests with different branches

As seen from looking through the pull requests menu, there has been disparity on which branches pull requests should be made from. As outlined in the project outline, "Create your pull requests from non-main branches.". Lets make sure we are all submitting pull requests from a separate branch other than our main to keep everything consistent.

For example--

Add more commits by pushing to the main branch on pamaph20/CS340-S23-Notes.

Regarding Class Code/Scripts

Hi all,

Just a quick note about code we produce in class and how we implement it into our study notes.
Given the fact that those who are reviewing the code in the notes wouldn't have the privilege of asking questions in class, I think it is a good idea for us to go over the code we are putting into our notes and make sure it is easily understood through comments in the code, sometimes even beyond what those we put in during class if need be.

If anyone has anything to add to this, suggestions are welcome.

Empty lecture day 7 notes

I have added an outline for lecture day 7's notes under a day7 branch, but the actual notes are missing for this day.

File Naming Scheme

In issue #38, it seemed we had decided on the file naming scheme as lecturex_y-yy.md where x is the lecture number and y-yy is the month and day of the lecture. But in the style guide, the file naming scheme is defined as lecture DayXNotes.md where x is the lecture number. Which one are we using?

Missing Lecture 25

Lecture 25 notes are still unfulfilled; Please upload ASAP for review @hbsecor

Repo Organization? What do we want?

Hey all,

How do we want to organize this repo? I think it might be overwhelming if we have all of our lecture notes and other documents in the top level directory.

My only idea is to have a directory for all of our lecture notes that is separate from our style guide, course overview, etc. Something like this?

CS340-S23-Notes

• Lecture Notes Directory
  • lecture1.md
  • lecture2.md
  • and so on
• StyleGuide.md
• CourseOverview.md
• and so on

Does anyone have any other ideas for organization?

Style Guide Flow chart formatting??

I need to insert a flow chart for the GitHub process of pulling and pushing. I wasn't quite sure how this should be done. I thought about adding a photo I found online but also thought about just typing it out the best I can. What do you guys think I should do? For reference this is from day 8.

File names

Hey I noticed file some file names are different, some have lecturex.md and others have lecturex_date.md. We should all try to stay consistent. I did mine without the date, what seems better to you guys?

Class2Lecture

Within my file, I created a header and just did bullet points some of which contained other sub-points. What is the overall format that we are thinking of? should we do topics with bullet points and do life definitions as Kevin does them in class and so on. Please let me know what you are all thinking!

Naming the files

Hey everyone,

How are we naming our files? lecture_x.md or lecturex.md, where x is the number of the lecture you're working on?

Style Guide Suggestions

I have claimed the style guide appendix. Please comment on this issue with any formatting or other style guide suggestions. I will go through comments and other issues and create the style guide based on group consensus wherever possible.

lecture titles inconsistent

It would be helpful for everyone to name the lecture notes with the same title. Either a name like "lecture-20.md" or "day20notes.md".

Hey Rob

@rmfust20 can you submit your commit soon so that I can start reviewing it?

Claiming a lecture day

Hello everyone,

For the purposes of organization, and minimizing overlap, please claim the day/item you will take notes on, in excel below.

Link: https://stlawu-my.sharepoint.com/:x:/r/personal/hmnsen19_stlawu_edu/Documents/Project%202%20Class%20Notes.xlsx?d=w8186212a6efc4f7ca9443b423303e1c2&csf=1&web=1&e=UsF0a7

Thank you,
Hans

Creating the Additional Pull Request

I was wondering if we needed to wait for our pull requests to be verified/approved before we can fork them and edit them for contribution. I can't seem to figure out how to fork (or gain access to) a pull request that hasn't been approved. Let me know if anyone has a solution to this or any comments on this.

Forked Main Repo Question

Is it problematic if my main repository contains more files than the original repository?
That is, should I delete the lecture 4 outline in my main branch, since I created a day 4 branch for it?

Class 3 Lecture Notes

I have created a pull request after creating a new branch on my forked repo and supplying an outline for Lecture 3 on January 25th, which will be populated with actual data at another time prior to the P2 deadline.

Completing pull request class 9

hey, @JamesB5201 could please complete your pull request so I can start reviewing soon. Thank you!

Committing from specific branches vs Main branch

I noticed some people are making separate branches in their forked copies of the repo and committing from those, while some other people are committing from their Main branches. Does it matter which option we use? Would that only affect local repository organization?

Overview in each document

I've noticed that many of the lecture notes do not currently have an overview section at the beginning. Not only to follow the style guide but to improve the usability of these notes we should include overviews.

Suggestions for next pull requests

Hi Everyone,

I wanted to point out some things that would be easy for us to clean up on our next pull requests that we are trying to have done by this Friday 4/21.

• Directory Structure: it was mentioned in issue #30 that we wanted to utilize a Lecture Notes folder to hold all lecture notes files, so we could move our lecture notes files to that folder.
• File Naming: also in issue #30, we talked about naming lecture notes files with the naming system "lecture" followed by the lecture number (lecture1.md, lecture2.md, etc.). We could rename our lecture notes files so that they are all consistent with this naming system.

Does anyone have any other suggestions of things that would be easy to clean up in the next pull request?