Miscellaneous tasks. Adding in Issue Templates and Pull Request Templates so that participants have access to them when repo is forked. Adding vscode to the gitignore file. Added a standardized submissions heading to all assignments. Updating links in README.md to reflect new changes. Changing "data structures and algorithms" to "algorithms and data structure" as to reflect the actual name of the module. Removing Contributions and only leaving land acknowledgements.

danielrazavi · danielrazavi · commit 491b7efb704f · 2024-04-22T11:30:28.000-04:00
diff --git a/.github/issue_template.yaml b/.github/issue_template.yaml
@@ -0,0 +1,46 @@
+name: Bug Report
+description: Report a bug
+title: "[Bug]: "
+labels: ["bug"]
+assignees:
+  - danielrazavi
+  - rohanalexander
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please fill out the sections below to help everyone identify and fix the bug
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe your issue
+      placeholder: When I click here this happens
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Steps to reproduce
+      placeholder: |
+        1. Go to page X
+        2. Click here
+        3. Click there
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: What was the expected result?
+      placeholder: I expected this to happen
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Put here any screenshots or videos (optional)
+  - type: textarea
+    id: assignee
+    attributes:
+      label: Put here the code owner you'd like to review this issue.
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for reporting this issue! We will get back to you as soon as possible.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,17 @@
+## What changes are you trying to make? (e.g. Adding or removing code, refactoring existing code, adding reports)
+
+## What did you learn from the changes you have made?
+
+## Was there another approach you were thinking about making? If so, what approach(es) were you thinking of?
+
+## Were there any challenges? If so, what issue(s) did you face? How did you overcome it?
+
+## How were these changes tested?
+
+## A reference to a related issue in your repository (if applicable)
+
+## @mentions of the person or team responsible for reviewing proposed changes (At least 2 people)
+- 
+
+## Checklist
+- [ ] I can confirm that my changes are working as intended
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 .DS_Store
+.vscode/
diff --git a/02_assignments/assignment_1.ipynb b/02_assignments/assignment_1.ipynb
@@ -290,12 +290,6 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Submission Requirements\n",
-    "\n",
-    "Create and submit a public GitHub repository with the following:\n",
-    "\n",
-    "-   The PDF of the problem you have solved\n",
-    "\n",
     "## Evaluation Criteria\n",
     "\n",
     "-   Problem is accurately stated in the student’s own words\n",
@@ -306,10 +300,32 @@
     "\n",
     "-   Clarity in explaining why the solution works, its time and space complexity\n",
     "\n",
-    "-   Clarity in the proposal to the alternative solution\n",
+    "-   Clarity in the proposal to the alternative solution"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Submission Information\n",
+    "\n",
+    "Please review our [Assignment Submission Guide](https://github.com/UofT-DSI/onboarding/blob/main/onboarding_documents/submissions.md) for detailed instructions on how to format, branch, and submit your work. Following these guidelines is crucial for your submissions to be evaluated correctly.\n",
+    "\n",
+    "### Submission Parameters:\n",
+    "* Submission Due Date: `HH:MM AM/PM - DD/MM/YYYY`\n",
+    "* The branch name for your repo should be: `assignment-1`\n",
+    "* What to submit for this assignment:\n",
+    "    * This Jupyter Notebook (assignment_1.ipynb) should be populated and should be the only change in your pull request.\n",
+    "* How the pull request link should look like for this assignment: `https://github.com/<your_github_username>/algorithms_and_data_structures/pull/<pr_id>`\n",
+    "    * Please verify that this link format is correctly implemented and accessible in a private browser session. This ensures that the technical facilitator and learning support staff can access your submission without any issues.\n",
+    "\n",
+    "Checklist:\n",
+    "- [ ] Created a branch with the correct naming convention.\n",
+    "- [ ] Ensured that the repository is public.\n",
+    "- [ ] Reviewed the PR description guidelines and adhered to them.\n",
+    "- [ ] Verified that the pull request link is correctly formatted and accessible via a private browser session.\n",
     "\n",
-    "## Submission Deadline\n",
-    "TBD\n"
+    "If you encounter any difficulties or have questions, please don't hesitate to reach out to our team via Slack or email. Our Technical Facilitators and Learning Support staff are here to help you navigate any challenges."
    ]
   }
  ],
diff --git a/02_assignments/assignment_2.ipynb b/02_assignments/assignment_2.ipynb
@@ -151,20 +151,6 @@
     "# Your answer here"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "\n",
-    "## Submission Requirements \n",
-    "\n",
-    "In the same repository you submitted assignment 1, please ADD the following:\n",
-    "\n",
-    "-   The PDF of the Jupyter Notebook you created for Assignment 2.\n",
-    "\n",
-    "Please name your files appropriately!\n"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -182,11 +168,32 @@
     "\n",
     "-   Clarity in explaining why the solution works, its time and space complexity\n",
     "\n",
-    "-   Quality of critique of your partner's assignment, if necessary\n",
+    "-   Quality of critique of your partner's assignment, if necessary\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Submission Information\n",
+    "\n",
+    "Please review our [Assignment Submission Guide](https://github.com/UofT-DSI/onboarding/blob/main/onboarding_documents/submissions.md) for detailed instructions on how to format, branch, and submit your work. Following these guidelines is crucial for your submissions to be evaluated correctly.\n",
+    "\n",
+    "### Submission Parameters:\n",
+    "* Submission Due Date: `HH:MM AM/PM - DD/MM/YYYY`\n",
+    "* The branch name for your repo should be: `assignment-2`\n",
+    "* What to submit for this assignment:\n",
+    "    * This Jupyter Notebook (assignment_2.ipynb) should be populated and should be the only change in your pull request.\n",
+    "* How the pull request link should look like for this assignment: `https://github.com/<your_github_username>/algorithms_and_data_structures/pull/<pr_id>`\n",
+    "    * Please verify that this link format is correctly implemented and accessible in a private browser session. This ensures that the technical facilitator and learning support staff can access your submission without any issues.\n",
     "\n",
-    "## Submission Deadline\n",
+    "Checklist:\n",
+    "- [ ] Created a branch with the correct naming convention.\n",
+    "- [ ] Ensured that the repository is public.\n",
+    "- [ ] Reviewed the PR description guidelines and adhered to them.\n",
+    "- [ ] Verified that the pull request link is correctly formatted and accessible via a private browser session.\n",
     "\n",
-    "TBD\n"
+    "If you encounter any difficulties or have questions, please don't hesitate to reach out to our team via Slack or email. Our Technical Facilitators and Learning Support staff are here to help you navigate any challenges.\n"
    ]
   }
  ],
diff --git a/04_instructors/README.md b/04_instructors/README.md
@@ -19,16 +19,16 @@ The `/04-homework` directory contains all the homework, a learner can do to demo
 
 | Lesson | Topic                                                       | Resources  |
 |--------|-------------------------------------------------------------|------------|
-| 1      | Motivation and Big-O Notation                               | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/lessons/1_motivation-big-o.pdf) |
-| 2      | Data Structures, Sorting, and Searching                     | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/lessons/2_ds-search-sort.pdf) |
-| 3      | Recursion              				                             | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/lessons/3_recursion.pdf) |
+| 1      | Motivation and Big-O Notation                               | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/01_slides/1_motivation_big_o.ipynb) |
+| 2      | Data Structures, Sorting, and Searching                     | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/01_slides/2_ds_search_sort.ipynb) |
+| 3      | Recursion              				                             | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/01_slides/3_recursion.ipynb) |
 
 ### Week 2
 
 | Lesson | Topic                                                       | Resources  |
 |--------|-------------------------------------------------------------|------------|
-| 4      | Recursion              				                             | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/lessons/3_recursion.pdf) |
-| 5      | Recursive Data Structures                                   | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/lessons/4_recursive-ds.pdf) |
+| 4      | Recursion              				                             | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/01_slides/3_recursion.ipynb) |
+| 5      | Recursive Data Structures                                   | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/01_slides/3_recursion.ipynb) |
 
 ## How do you assign assignments?
 Assignments are given and assigned at the start of each week at the end of the first lecture. The Technical Facilitator will announce to the learners what the assignment is about, and how everything they will learn within the week will equip them to work on the assignment.
diff --git a/README.md b/README.md
@@ -18,12 +18,10 @@
   + [Videos](#videos)
   + [How to get help](#how-to-get-help)
 * [Folder Structure](#folder-structure)
-* [Acknowledgements and Contributions](#acknowledgements-and-contributions)
-* [Achnowledgements](#achnowledgements)
-  + [Contributions ](#contributions)
+* [Acknowledgement](#acknowledgement)
 
 ## Description
-The course was created by the University of Toronto's Data Science Institute. An understanding of data structures and algorithms (DSA), will aid the implementation of data science or machine learning methods in practice. Machine learning emphasizes prediction, scalability, and autonomy. Understanding DSA is essential to the latter two aims of ML. For instance, students will be able to describe how algorithms will perform when scaled or find practical methods for computers to solve problems autonomously. Finally, the industry often requires knowledge of DSAs and the ability to communicate the solving process. This course will provide the knowledge and terminology necessary to succeed in these situations.
+The course was created by the University of Toronto's Data Science Institute. An understanding of algorithms and data structures will aid the implementation of data science or machine learning methods in practice. Machine learning emphasizes prediction, scalability, and autonomy. Understanding DSA is essential to the latter two aims of ML. For instance, students will be able to describe how algorithms will perform when scaled or find practical methods for computers to solve problems autonomously. Finally, the industry often requires knowledge of DSAs and the ability to communicate the solving process. This course will provide the knowledge and terminology necessary to succeed in these situations.
 
 The beginning of the course will introduce students to terminology to discuss algorithms. This includes Big-O notation, time and space complexity. The next section will explore array-based data structures, searching, and sorting. Students should be able to justify algorithm or data structure choices based on time and space complexity analysis. Then, students will be introduced to recursion. We will solve problems using recursion and implement data structures that are best understood from a recursive perspective. Again, students will justify their design choices. The last portion of the course will be dedicated to solving optimization problems quickly. Students will be introduced to a variety of techniques to solve problems and identify when and how a solution can be optimized.
 
@@ -68,19 +66,19 @@ Learners are encouraged to be active participants while coding and are encourage
     * [Jupyter](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter)
     * [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
 * Learners must not use generative AI such as ChatGPT to generate code to complete assignments. It should be used as a supportive tool to seek out answers to questions you may have.
-* We expect learners to have completed the [onboarding repo](https://github.com/UofT-DSI/Onboarding/tree/tech-onboarding-docs).
+* We expect learners to have completed the [onboarding repo](https://github.com/UofT-DSI/onboarding/tree/main/onboarding_documents).
 * Webcam is optional although highly encouraged. We understand that not everyone may have the space at home to have the camera on.
 
 
 ### Lesson Schedule
 
 | Lesson | Topic                                                       | Resources  |
 |--------|-------------------------------------------------------------|------------|
-| 1      | Motivation and Big-O Notation                               | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/lessons/1_motivation-big-o.pdf) |
-| 2      | Data Structures, Sorting, and Searching                     | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/lessons/2_ds-search-sort.pdf) |
-| 3      | Recursion              				                             | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/lessons/3_recursion.pdf) |
-| 4      | Recursion              				                             | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/lessons/3_recursion.pdf) |
-| 5      | Recursive Data Structures                                   | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/lessons/4_recursive-ds.pdf) |
+| 1      | Motivation and Big-O Notation                               | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/01_slides/1_motivation_big_o.ipynb) |
+| 2      | Data Structures, Sorting, and Searching                     | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/01_slides/2_ds_search_sort.ipynb) |
+| 3      | Recursion              				                             | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/01_slides/3_recursion.ipynb) |
+| 4      | Recursion              				                             | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/01_slides/3_recursion.ipynb) |
+| 5      | Recursive Data Structures                                   | [Slides](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/01_slides/3_recursion.ipynb) |
 
 ### Textbooks
 
@@ -94,8 +92,8 @@ The course content, slides, and recommended problems follow these two textbooks.
 ## Marking Scheme
 | Assessment       | Description          | Due Date |
 |------------------|----------------------|----------|
-| [Assignment 1](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/assignments/assignment%201.md) | DSA coding practice  | TBD |
-| [Assignment 2](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/assignments/assignment%202.md) | mock interview       | TBD |
+| [Assignment 1](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/02_assignments/assignment_1.ipynb) | DSA coding practice  | TBD |
+| [Assignment 2](https://github.com/UofT-DSI/algorithms_and_data_structures/blob/main/02_assignments/assignment_2.ipynb) | mock interview       | TBD |
 
 **How to submit assignments, late policy, academic integrity.**
 Please submit your assignment by uploading the PDFs to your Google Drive folder used for assignment submissions.
@@ -125,7 +123,7 @@ Feel free to use the following as resources:
 - [Sorting Playlist](https://www.youtube.com/playlist?list=PL9xmBV_5YoZOZSbGAXAPIq1BeUf4j20pl)
 
 ### How to get help
-![image](/steps_to_ask_for_help.png)
+![image](./steps_to_ask_for_help.png)
 
 <hr>
 
@@ -153,11 +151,7 @@ Feel free to use the following as resources:
 * README: This file!
 * .gitignore: Files to exclude from this folder, specified by the Technical Facilitator
 
-## Acknowledgements and Contributions
+## Acknowledgement
+
+We wish to acknowledge this land on which the University of Toronto operates. For thousands of years, it has been the traditional land of the Huron-Wendat, the Seneca, and most recently, the Mississaugas of the Credit River. Today, this meeting place is still the home to many Indigenous people from across Turtle Island and we are grateful to have the opportunity to work on this land.
 
-### Achnowledgements
-* The module was developed by [Alex](https://www.linkedin.com/in/kunzhi-yu/) Yu](https://www.linkedin.com/in/kunzhi-yu/) under the supervision of Rohan Alexander. 
-* We wish to acknowledge this land on which the University of Toronto operates. For thousands of years, it has been the traditional land of the Huron-Wendat, the Seneca, and most recently, the Mississaugas of the Credit River. Today, this meeting place is still the home to many Indigenous people from across Turtle Island and we are grateful to have the opportunity to work on this land.
-### Contributions 
-* `algorithms_and_data_structures` welcomes issues, enhancement requests, and other contributions. To submit an issue, use the [GitHub
-issues](https://github.com/UofT-DSI/algorithms_and_data_structures/issues).
