Skip to content

Commit

Permalink
Project P5 (#163)
Browse files Browse the repository at this point in the history
  • Loading branch information
Mones26 authored Nov 12, 2024
1 parent a4bfaae commit 9926f3e
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 30 deletions.
14 changes: 7 additions & 7 deletions docs/_data/schedule.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1080,10 +1080,10 @@

- date: Mon Nov 18
homework:
deadline: ""
link: ""
name: ""
numDays: 0
deadline: "Due Tue, November 19th @ 11:59pm"
link: "projects/P5"
name: "P5A - Project & Tasks Selection Check-In"
numDays: 2
lecture:
link: ""
name: ""
Expand Down Expand Up @@ -1116,9 +1116,9 @@

- date: Wed Nov 20
homework:
deadline: ""
link: ""
name: ""
deadline: "Due Sun, December 9th @ 11:59pm"
link: "projects/P5"
name: "P5B and P5C - Open Source Excursion"
numDays: 0
lecture:
link: ""
Expand Down
19 changes: 10 additions & 9 deletions docs/projects/P5/1_projectcheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

## Deliverables

**Project & Task Selection** – 80 points – due ~~Tuesday, April 9th, 11:59pm~~ Wednesday, April 10th, 11:59pm
**Project & Task Selection** – 80 points

- [Check-In Presentation Slides](#check-in-presentation-80-pts) – due ~~Tuesday, April 9th, 11:59pm~~ Wednesday, April 10th, 11:59pm
- **Presentation Date** – Upload your presentation video [here](https://drive.google.com/drive/folders/1nHW97a6oRaQrVLqTo-F1bKwVc6G3IFZA?usp=sharing)
- [Project Selectiion](#open-source-project-selection) - enter project name and URL in the spreadsheet by Tuesday, November 19th, 11:59pm
- [Task Selection Checkpoint Presentation](#checkpoint-presentation-80-pts) – slides and video recording due Sunday, November 24th, 11:59pm


## Open Source Project Selection

You may select any active open source project in any language, as long as it's not already being selected on by another team. You can find a list of open source projects selected by other teams on the **[Public Project Selection Spreadsheet](https://docs.google.com/spreadsheets/d/1UTogivA8FraWcPC6DC_fi70g33_ugmslAQsXmsSA4jc/edit?usp=sharing)**.
You may select any active open source project in any language, as long as it's not already being selected on by another team. You can find a list of open source projects selected by other teams on the **[Public Project Selection Spreadsheet](https://docs.google.com/spreadsheets/d/1IokRZCYi2j8McCQ9BZQPeTp1yY6PZ4psq2D24rPU7N0/edit?gid=1777881413#gid=1777881413)**.

Here are some helpful resources for finding open source projects:

Expand All @@ -21,14 +21,15 @@ Here are some helpful resources for finding open source projects:
- [A list of beginner friendly projects](https://github.com/MunGell/awesome-for-beginners)
- [Apache projects](http://www.apache.org/)
- [Mozilla projects](https://firefox-source-docs.mozilla.org/contributing/contributing_to_mozilla.html)
- You may also check the other sheets in the **[Public Project Selection Spreadsheet](https://docs.google.com/spreadsheets/d/1IokRZCYi2j8McCQ9BZQPeTp1yY6PZ4psq2D24rPU7N0/edit?gid=1777881413#gid=1777881413)** which will include Projects and whether they were merged into main.

You may want to consider any open-source projects you have used before, or are interested in using in the future!

The open source project you pick should be ^^active^^ and ^^have multiple contributors^^. Generally you want to pick projects that are **quick at reviewing and accepting PRs from external contributors** for a better chance of getting your bonus. Previous students have lamented choosing dead or maintenance projects without sufficient community support. Do not make this mistake.

If you have questions on if we would consider a project active, contact the course staff.

Once you have selected a project, add it to the **[Public Project Selection Spreadsheet](https://docs.google.com/spreadsheets/d/1Y361Z1H-oZsyQUvrHyWKMOPPWSsA7-pHn32pRrvNRns/edit?usp=sharing)**.
Once you have selected a project, add it to the **[Public Project Selection Spreadsheet](https://docs.google.com/spreadsheets/d/1IokRZCYi2j8McCQ9BZQPeTp1yY6PZ4psq2D24rPU7N0/edit?gid=1777881413#gid=1777881413)**. We highly recommend you also think about potential tasks (see below) before finalizing on a project, as your success depends heavily on the chosen task.

## Task Selection

Expand All @@ -48,11 +49,11 @@ If you have questions on these criteria, contact the course staff.

Once you have selected a project and task(s), break them down into subtasks, consider their priority and assign them to each team member. Identify a set of tasks as your core goal for this project, and another set of tasks as stretch goals.

You are expected to **achieve your core goal for this project**, and stretch goals as much as possible. We will work with you to adjust your goals during the check-in presentation to ensure that they are appropriate your team size and timeframe.
You are expected to **achieve your core goal for this project**, and stretch goals as much as possible. We will work with you to adjust your goals during the checkpoint presentation to ensure that they are appropriate your team size and timeframe.

As per previous project, ^^plan before you start coding^^. You should identify risks and requirements, and develop a collaboration plan and schedule.

## Check-In Presentation (80 pts)
## Checkpoint Presentation (80 pts)

The recitation before carnival will be asynchronous to allow for viewing of the eclipse.

Expand All @@ -62,7 +63,7 @@ The recitation before carnival will be asynchronous to allow for viewing of the

**Your group presentation will serve as a check-in to determine if the open source project and task(s) chosen were reasonable**

Your **7-minute** check-in presentation should include (the recommended slides amount is in parenthesis):
Your **7-minute** checkpoint presentation should include (the recommended slides amount is in parenthesis):

1. **Overview and Justification** (~1 slide)
An overview on the project you selected, summarizing the relevant characteristics you considered when making your selection. Beyond whatever additional information you collect in your research, include at least a name, a website link, and a brief description of the project (what it does, who uses it, etc).
Expand Down Expand Up @@ -101,4 +102,4 @@ Your **7-minute** check-in presentation should include (the recommended slides a
- We expect you to identify risks that are specific to your project and team. For example, if you are working on a project that is written in a language that none of your team members have used before, you should identify this as a risk and discuss how you will mitigate it.
- We will not accept risks that are generic to all open source projects (e.g., "the project may be abandoned"), or risks that are generic to all software development projects (e.g., "the project may have bugs").

Submit the presentation deck listed above as a **single PDF** file per team to **Gradescope**. You will be presenting this in the recitation after Thanksgiving break.
Submit the presentation deck listed above as a **single PDF** file per team to **Gradescope** and upload a video recording in this [Google drive folder](https://drive.google.com/drive/folders/1jnwGV4qbPs_DATSLHeagPXM9YpYwrlvG?usp=drive_link). You will be presenting this in the recitation on Monday, November 25th.
6 changes: 3 additions & 3 deletions docs/projects/P5/2_projectfinal.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

## Deliverables

**Project Report and Presentation** – due Sunday, April 28th, 11:59pm
**Project Report and Presentation** – due Sunday, December 8th, 11:59pm

- [Project Report](#project-report-200-pts) (200 pts)
- [Extra Credit](#project-report-200-pts) (20 pts)
- [Project Presentation Slides](#project-presentations-100-pts) (100 points, graded based on presentation)

**Presentation Date** – Monday, April 29th, 5:30-8:30pm, during exam timeslot
**Presentation Date** – Monday, December 9th, 1:00-4:00pm, during exam timeslot

**Reflection** – due Monday, April 29th, 11:59pm
**Reflection** – due Monday, December 9th, 11:59pm

- [Reflections & Peer Review](#individual-reflection-peer-evaluations-20-pts) (20 pts)

Expand Down
15 changes: 8 additions & 7 deletions docs/projects/P5/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,29 @@ If you demonstrate to us that your change has been accepted and integrated into
## Deliverables and Deadlines
This will is your final project with your group. There are 3 deadlines for this project. The project is worth a total of 400 points (~24% of your final grade).

A) [**Project & Task Selection**](/projects/P5/1_projectcheck) – 80 points – due ~~Tuesday, April 9th, 11:59pm~~ Wednesday, April 10th, 11:59pm
A) [**Project & Task Selection**](1_projectcheck.md) – 80 points – due Tuesday, November 19th, 11:59pm

- Check-In Presentation (80 pts) - **Submitted Recording by Wednesday April 10th**
- Project selection - **due Tuesday, November 19th**
- Check-In Presentation (slides + recording) (80 pts) - **due Sunday November 24th**

B) [**Project Final Report & Presentations**](/projects/P5/2_projectfinal) – 300 points – due Sunday, April 28th, 11:59pm
B) [**Project Final Report & Presentations**](2_projectfinal.md) – 300 points – due Sunday, December 8th, 11:59pm

- Project Report (200 pts)
- *Extra Credit (20 pts)*
- Project Presentation (100 points) - **Held during exam timeslot on Monday, April 29th, 5:30-8:30pm**
- Project Presentation (100 points) - **Held during exam timeslot on Monday, December 9th, 1:00-4:00pm**

C) [**Individual Reflections**](/projects/P5/2_projectfinal) – 20 points – due Monday, April 29th, 11:59pm
C) [**Individual Reflections**](2_projectfinal.md) – 20 points – due Monday, December 9th, 11:59pm

- Reflections & Peer Review (20 pts)

!!! tip

**This is a large assignment spanning from now until your final exam timeslot.** We estimate that this project will take each student on the team on average 8 hours/week over the next 5 weeks, for a total of 40 hours. We **highly recommend** reading through the entire assignment before starting so you are aware of our expectations for the later deliverables.
**This is a large assignment spanning from now until your final exam timeslot.** We estimate that this project will take each student on the team on average 8 hours/week over the next 4 weeks. We **highly recommend** reading through the entire assignment before starting so you are aware of our expectations for the later deliverables.

To manage all of the write-ups, we recommend saving the pages as a PDF to print or annotate on as you work through the assignment with your team.

!!! attention "Contributions"

We want to ensure that everyone is participating fully in the final project. For this project, we will be assessing participation in a variety of ways, including: artifact evaluation, self & peer evaluation. Credit due for the team components of P5 will be awarded based on evidence of full participation in the team. **Partial participation will receive partial credit.**

If severe teamwork issues arise please contact the course staff.
If severe teamwork issues arise please contact the course staff.
8 changes: 4 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,10 @@ nav:
- "Azure Deployment Instructions": projects/P3/deployment.md
- "Project 4: Architecting an LLM Integration":
- projects/P4/index.md
# - "Project 5: Open Source Excursion":
# - projects/P5/index.md
# - "5A Project and Task Selection": projects/P5/1_projectcheck.md
# - "5B Project Presentations, Final Report, and Reflections": projects/P5/2_projectfinal.md
- "Project 5: Open Source Excursion":
- projects/P5/index.md
- "5A Project and Task Selection": projects/P5/1_projectcheck.md
- "5B Project Presentations, Final Report, and Reflections": projects/P5/2_projectfinal.md

- Recitations:
#- recitations/index.md # Dummy home page; remove once we start adding recitations below
Expand Down

0 comments on commit 9926f3e

Please sign in to comment.