From 749860f2214f9733d02baed8644cda64628225fa Mon Sep 17 00:00:00 2001 From: ll7 Date: Fri, 1 Nov 2024 11:07:26 +0100 Subject: [PATCH 1/6] Update README.md structure and fix broken link --- doc/README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/doc/README.md b/doc/README.md index 7546ccb8..197a48bd 100644 --- a/doc/README.md +++ b/doc/README.md @@ -2,16 +2,15 @@ This document provides an overview of the structure of the documentation. -- [PAF Documentation](#paf-documentation) - - [`general`](#general) - - [`development`](#development) - - [`research`](#research) - - [`examples`](#examples) - - [`perception`](#perception) - - [`planning`](#planning) - - [`acting`](#acting) - - [`assets`](#assets) - - [`dev_talks`](#dev_talks) +- [`general`](#general) +- [`development`](#development) +- [`research`](#research) +- [`examples`](#examples) +- [`perception`](#perception) +- [`planning`](#planning) +- [`acting`](#acting) +- [`assets`](#assets) +- [`dev_talks`](#dev_talks) ## `general` @@ -47,4 +46,4 @@ The [`assets`](./assets/) folder contains mainly images that are used inside the ## `dev_talks` -The [`dev_talks`](./dev_talks/) folder contains the protocols of each sprint review and roles that the students fill during the project. +The [`dev_talks`](./dev_talks/README.md) folder contains the protocols of each sprint review and roles that the students fill during the project. From c7baf35ce32969fbbd4a0b6964681fb65b922fce Mon Sep 17 00:00:00 2001 From: ll7 Date: Fri, 1 Nov 2024 11:07:41 +0100 Subject: [PATCH 2/6] Add Dev Talks README.md --- doc/dev_talks/README.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 doc/dev_talks/README.md diff --git a/doc/dev_talks/README.md b/doc/dev_talks/README.md new file mode 100644 index 00000000..f902de55 --- /dev/null +++ b/doc/dev_talks/README.md @@ -0,0 +1,5 @@ +# Dev Talks + +- [PAF24](./paf24/README.md) +- [PAF23](./paf23/) + From 4d70e6cb41daeab393493830773edb7842f536dd Mon Sep 17 00:00:00 2001 From: ll7 Date: Fri, 1 Nov 2024 11:08:28 +0100 Subject: [PATCH 3/6] Add PAF24 README.md --- doc/dev_talks/paf24/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 doc/dev_talks/paf24/README.md diff --git a/doc/dev_talks/paf24/README.md b/doc/dev_talks/paf24/README.md new file mode 100644 index 00000000..04311f31 --- /dev/null +++ b/doc/dev_talks/paf24/README.md @@ -0,0 +1,16 @@ +# PAF24 + +**Summary**: The PAF24 folder contains documents that are relevant for the PAF24 group. + +- [General Information](#general-information) +- [Notes for Sprints](#notes-for-sprints) + +## General Information + +- [Mermaid Gantt Chart](./mermaid_paf24.md) +- [Student Roles](./student_roles.md) +- [Joker Rules] + +## Notes for Sprints + +- [T03](./T03_2024-10-28.md) From 5dc5aa35209585c16da870fb21426bdc3c4513fa Mon Sep 17 00:00:00 2001 From: ll7 Date: Fri, 1 Nov 2024 11:08:56 +0100 Subject: [PATCH 4/6] Add PAF24 Joker Rules documentation Fixes Add Joker Rules for PAF24 #391 --- doc/dev_talks/paf24/joker_rules_paf24.md | 60 ++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 doc/dev_talks/paf24/joker_rules_paf24.md diff --git a/doc/dev_talks/paf24/joker_rules_paf24.md b/doc/dev_talks/paf24/joker_rules_paf24.md new file mode 100644 index 00000000..50001e2f --- /dev/null +++ b/doc/dev_talks/paf24/joker_rules_paf24.md @@ -0,0 +1,60 @@ +# Joker Rules PAF24 + +**Purpose**: This document outlines the rules for using the Joker card in the PAF24 project. + +- [1. Overview](#1-overview) +- [2. Using the Joker Card](#2-using-the-joker-card) +- [3. Special Circumstances](#3-special-circumstances) + - [3.1. Unable to Present Work Due to Scheduling Conflicts](#31-unable-to-present-work-due-to-scheduling-conflicts) + - [3.2. Illness or Emergency](#32-illness-or-emergency) + +## 1. Overview + +- **Project Duration**: October 2024 – March 2025 +- The Joker card allows you to be excused from duties during specific periods, especially during the exam phase in February 2025. +- **Total Joker Allocation**: + - **Joker Card** Up to 4 weeks throughout the project. + - **Presentation Only Joker Card** Maximum of 2 uses. +- **When to Use**: The Joker card should be played if you are unable to present your work during a sprint review or if the amount of work completed is insufficient. +- The intention of the Joker card is to ensure you have the appropriate time to prepare your exam phase. + +## 2. Using the Joker Card + +To play the Joker card: + +1. **Notify the Team and Chair**: Inform both the team and chair staff by posting in the `#joker` channel on our Discord server. +2. **Deadline**: Notify the team at least **7 days** before the sprint review. +3. **Example Post**: + - “I would like to play the Joker card for the sprint review on 2024-11-25.” +4. Your name and intent will be confirmed by the team and chair. + +> [!NOTE] 2 week sprints require two Joker cards to cover the entire sprint. + +## 3. Special Circumstances + +### 3.1. Unable to Present Work Due to Scheduling Conflicts + +- If you completed the sprint’s work but cannot present it, you have two options: + 1. Play the standard Joker card. + 2. Use a `Presentation Only Joker Card` by arranging for a teammate to present on your behalf. + +- **Presentation Only Joker Card Details**: + - **Maximum Use**: Limited to two times throughout the project. + - **Requirements**: + - Notify the team and chair at least **7 days** before the sprint review. + - Submit a written summary of your work in the `#joker` Discord channel at least **1 day** before the review. + - Find a teammate who presents your work. + +- **Written Summary Contents**: + - Overview of completed work. + - Key achievements. + - Lessons learned. + - Goals for the next sprint. + +> [!CAUTION] Presentation Only Joker Card +> We encourage all team members to only present your teammates work if absolutely necessary. The work completed by your colleagues is their responsibility, and they should be the ones to present it. Furthermore, you should only present their work if you are familiar with it and can answer questions about it. Additionally, you should be confident that your team member has completed the work to a satisfactory standard. + +### 3.2. Illness or Emergency + +- **Illness**: If you cannot attend due to illness, provide a medical certificate to be excused from duties without using a Joker card. +- **Emergency**: Emergencies are evaluated individually. From 373041a6f18d307bc179f97b666485ab0459dd7c Mon Sep 17 00:00:00 2001 From: ll7 Date: Fri, 1 Nov 2024 11:11:26 +0100 Subject: [PATCH 5/6] Fix linting --- doc/dev_talks/README.md | 1 - doc/dev_talks/paf24/joker_rules_paf24.md | 7 +++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/dev_talks/README.md b/doc/dev_talks/README.md index f902de55..db9a4f8a 100644 --- a/doc/dev_talks/README.md +++ b/doc/dev_talks/README.md @@ -2,4 +2,3 @@ - [PAF24](./paf24/README.md) - [PAF23](./paf23/) - diff --git a/doc/dev_talks/paf24/joker_rules_paf24.md b/doc/dev_talks/paf24/joker_rules_paf24.md index 50001e2f..be5a3392 100644 --- a/doc/dev_talks/paf24/joker_rules_paf24.md +++ b/doc/dev_talks/paf24/joker_rules_paf24.md @@ -24,7 +24,7 @@ To play the Joker card: 1. **Notify the Team and Chair**: Inform both the team and chair staff by posting in the `#joker` channel on our Discord server. 2. **Deadline**: Notify the team at least **7 days** before the sprint review. -3. **Example Post**: +3. **Example Post**: - “I would like to play the Joker card for the sprint review on 2024-11-25.” 4. Your name and intent will be confirmed by the team and chair. @@ -52,7 +52,10 @@ To play the Joker card: - Goals for the next sprint. > [!CAUTION] Presentation Only Joker Card -> We encourage all team members to only present your teammates work if absolutely necessary. The work completed by your colleagues is their responsibility, and they should be the ones to present it. Furthermore, you should only present their work if you are familiar with it and can answer questions about it. Additionally, you should be confident that your team member has completed the work to a satisfactory standard. +> We encourage all team members to only present your teammates work if absolutely necessary. +> The work completed by your colleagues is their responsibility, and they should be the ones to present it. +> Furthermore, you should only present their work if you are familiar with it and can answer questions about it. +> Additionally, you should be confident that your team member has completed the work to a satisfactory standard. ### 3.2. Illness or Emergency From 0a044cefbe5a768afbb9f66eba3db016be721764 Mon Sep 17 00:00:00 2001 From: ll7 <32880741+ll7@users.noreply.github.com> Date: Fri, 1 Nov 2024 11:20:45 +0100 Subject: [PATCH 6/6] Update doc/dev_talks/paf24/joker_rules_paf24.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- doc/dev_talks/paf24/joker_rules_paf24.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/dev_talks/paf24/joker_rules_paf24.md b/doc/dev_talks/paf24/joker_rules_paf24.md index be5a3392..b325a71a 100644 --- a/doc/dev_talks/paf24/joker_rules_paf24.md +++ b/doc/dev_talks/paf24/joker_rules_paf24.md @@ -28,7 +28,7 @@ To play the Joker card: - “I would like to play the Joker card for the sprint review on 2024-11-25.” 4. Your name and intent will be confirmed by the team and chair. -> [!NOTE] 2 week sprints require two Joker cards to cover the entire sprint. +> [!NOTE] 2-week sprints require two Joker cards to cover the entire sprint. ## 3. Special Circumstances