Skip to content

Commit

Permalink
Merge pull request #411 from una-auxme/391-Add-Joker-Rules-for-PAF24
Browse files Browse the repository at this point in the history
Add Joker Rules for PAF24
  • Loading branch information
ll7 authored Nov 4, 2024
2 parents df9452d + 8a50190 commit 8141564
Show file tree
Hide file tree
Showing 4 changed files with 93 additions and 11 deletions.
21 changes: 10 additions & 11 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down Expand Up @@ -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.
4 changes: 4 additions & 0 deletions doc/dev_talks/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Dev Talks

- [PAF24](./paf24/README.md)
- [PAF23](./paf23/)
16 changes: 16 additions & 0 deletions doc/dev_talks/paf24/README.md
Original file line number Diff line number Diff line change
@@ -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)
63 changes: 63 additions & 0 deletions doc/dev_talks/paf24/joker_rules_paf24.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# 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.

0 comments on commit 8141564

Please sign in to comment.