From 8ca901f1be32f3a8993d85a56b4bab1d069fb0ea Mon Sep 17 00:00:00 2001 From: ll7 Date: Wed, 23 Oct 2024 12:35:05 +0200 Subject: [PATCH 1/5] refactor: Update sprint planning guidelines Update the sprint planning guidelines to provide a more comprehensive and organized structure. This includes adding sections for before sprint planning, sprint retrospective, at the start of sprint planning, at the end of sprint planning, after sprint planning, and daily stand-up. The guidelines also cover tasks such as updating issues, creating a new milestone, identifying key weaknesses, checking current project status, brainstorming tasks/issues, prioritizing tasks, identifying dependencies, estimating task duration, assigning issues to sprint milestone, assigning tasks, capacity planning, reviewing for missed problems, ensuring workload distribution, clarifying next steps, clarifying communication expectations, defining workflow for each issue, setting escalation plan, planning the pull request, and sprint review preparation. The guidelines also provide an example format for the daily stand-up. Fixes [Feature]: Add sprint planning guidelines #340 --- doc/development/sprint_planning_guidelines.md | 84 ++++++++++++++++++- 1 file changed, 83 insertions(+), 1 deletion(-) diff --git a/doc/development/sprint_planning_guidelines.md b/doc/development/sprint_planning_guidelines.md index f1aa12bf..e41cbb49 100644 --- a/doc/development/sprint_planning_guidelines.md +++ b/doc/development/sprint_planning_guidelines.md @@ -1,3 +1,85 @@ # Sprint Planning Guidelines -TODO +**Summary**: guidelines for the sprint planning process. + +- [1. Before Sprint Planning](#1-before-sprint-planning) +- [2. Sprint Retrospective](#2-sprint-retrospective) +- [3. At the Start of Sprint Planning](#3-at-the-start-of-sprint-planning) +- [4. At the End of Sprint Planning](#4-at-the-end-of-sprint-planning) +- [5. After Sprint Planning](#5-after-sprint-planning) +- [6. Daily Stand-up](#6-daily-stand-up) + +## 1. Before Sprint Planning + +1. **Update Issues** + - Visit the [Issues page](https://github.com/una-auxme/paf/issues) and: + - Add appropriate labels to each issue. + - Close any issues that are no longer relevant. + - Expand and refine issue descriptions as necessary. +2. **Create a New Milestone** + - Set up a new milestone for the upcoming sprint: [Milestones](https://github.com/una-auxme/paf/milestones). +3. **Identify Key Weaknesses** + - Focus on identifying the biggest weaknesses of the `agent`. + - Ask: *If you could magically solve one issue, which one would it be?* + +## 2. Sprint Retrospective + +Integrate learnings from the previous sprint’s retrospective. Ask: + +- Were there any difficulties with communication, task breakdown, or dependencies? +- How can these issues be addressed in the upcoming sprint? + +## 3. At the Start of Sprint Planning + +1. **Check Current Project Status** + - Review how many sprints are left and the current progress within the semester. + - Keep the project’s deadline in mind when planning tasks. +2. **Brainstorm Tasks/Issues** + - Generate meaningful tasks or issues and track them as issues in the system. + - Focus on clarity — do not criticize, only clarify each idea. +3. **Prioritize Tasks** + - Ask: *What tasks would make our system function (or "car") better?* + - Prioritize tasks based on importance and impact. +4. **Identify Dependencies** + - Ensure dependencies between tasks are clear. +5. **Estimate Task Duration** + - For each task, provide: + - Minimum expected time. + - Most likely expected time. + - Maximum time, beyond which escalation is necessary. +6. **Assign Issues to Sprint Milestone** + - Decide which issues should be included in this sprint. + +## 4. At the End of Sprint Planning + +1. **Assign Tasks** + - Assign each issue to at least one team member. +2. Capacity Planing: + - Consider each team member's availability and workload when assigning +3. **Review for Missed Problems** + - Have any potential problems been overlooked? +4. **Ensure Workload Distribution** + - Confirm that everyone has an appropriate amount of work. +5. **Clarify Next Steps** + - Does everyone know where to start and what their next steps are? +6. **Clarify Communication Expectations** + - Define the expected communication process throughout the sprint. + +## 5. After Sprint Planning + +1. **Define Workflow for Each Issue** + - When will you work on this issue? + - How will you collaborate with others? +2. **Set Escalation Plan** + - Define when and how issues should be escalated if problems arise. + - Where and when do you need help? +3. **Plan the Pull Request** +4. **Sprint Review Preparation** + - Prepare for the **Sprint Review** at the end of the sprint, ensuring: + - Tasks are complete and meet the Definition of Done. + - Documentation and demos are ready for presentation. + +## 6. Daily Stand-up + +- Engage in the daily asynchronous stand-up: + - Example format: *Today, I am working on issue `#xyz`. I’m facing a challenge with this aspect, but otherwise, things are progressing well.* From 89beaa7bda6f0513ab367f98341dfaf2fd982db0 Mon Sep 17 00:00:00 2001 From: ll7 <32880741+ll7@users.noreply.github.com> Date: Wed, 23 Oct 2024 12:42:38 +0200 Subject: [PATCH 2/5] Update doc/development/sprint_planning_guidelines.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- doc/development/sprint_planning_guidelines.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/development/sprint_planning_guidelines.md b/doc/development/sprint_planning_guidelines.md index e41cbb49..6d8cd100 100644 --- a/doc/development/sprint_planning_guidelines.md +++ b/doc/development/sprint_planning_guidelines.md @@ -73,7 +73,11 @@ Integrate learnings from the previous sprint’s retrospective. Ask: 2. **Set Escalation Plan** - Define when and how issues should be escalated if problems arise. - Where and when do you need help? -3. **Plan the Pull Request** +3. **Plan Pull Requests** + - Break down implementation into logical PR sizes + - Define PR review requirements and assignments + - Plan PR dependencies and merge order + - Document testing requirements for each PR 4. **Sprint Review Preparation** - Prepare for the **Sprint Review** at the end of the sprint, ensuring: - Tasks are complete and meet the Definition of Done. From ae8eb10d04c72ed56f1ff2f5cc33d2270401249b Mon Sep 17 00:00:00 2001 From: ll7 <32880741+ll7@users.noreply.github.com> Date: Wed, 23 Oct 2024 12:43:24 +0200 Subject: [PATCH 3/5] Update doc/development/sprint_planning_guidelines.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- doc/development/sprint_planning_guidelines.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/doc/development/sprint_planning_guidelines.md b/doc/development/sprint_planning_guidelines.md index 6d8cd100..87f07274 100644 --- a/doc/development/sprint_planning_guidelines.md +++ b/doc/development/sprint_planning_guidelines.md @@ -85,5 +85,13 @@ Integrate learnings from the previous sprint’s retrospective. Ask: ## 6. Daily Stand-up -- Engage in the daily asynchronous stand-up: - - Example format: *Today, I am working on issue `#xyz`. I’m facing a challenge with this aspect, but otherwise, things are progressing well.* +- Engage in the daily asynchronous stand-up using the following format: + ``` + 1. Yesterday: What did you complete? + - Completed tasks/PRs: #xyz, #abc + 2. Today: What are you working on? + - Current task: #def + - Blocked by/Waiting for: (if any) + 3. Challenges/Help needed? + - Any blockers or risks to discuss + ``` From 248cb311aceb164149666658e386869bf9e2d540 Mon Sep 17 00:00:00 2001 From: ll7 <32880741+ll7@users.noreply.github.com> Date: Wed, 23 Oct 2024 12:44:02 +0200 Subject: [PATCH 4/5] Update doc/development/sprint_planning_guidelines.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- doc/development/sprint_planning_guidelines.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/development/sprint_planning_guidelines.md b/doc/development/sprint_planning_guidelines.md index 87f07274..38b21a2a 100644 --- a/doc/development/sprint_planning_guidelines.md +++ b/doc/development/sprint_planning_guidelines.md @@ -54,14 +54,14 @@ Integrate learnings from the previous sprint’s retrospective. Ask: 1. **Assign Tasks** - Assign each issue to at least one team member. -2. Capacity Planing: +2. **Capacity Planning**: - Consider each team member's availability and workload when assigning 3. **Review for Missed Problems** - Have any potential problems been overlooked? 4. **Ensure Workload Distribution** - Confirm that everyone has an appropriate amount of work. 5. **Clarify Next Steps** - - Does everyone know where to start and what their next steps are? + - Does everyone know where to start, and what their next steps are? 6. **Clarify Communication Expectations** - Define the expected communication process throughout the sprint. From a84a23bd13958a7103c4f71bb4ad4d53012c2abe Mon Sep 17 00:00:00 2001 From: ll7 Date: Wed, 23 Oct 2024 12:56:52 +0200 Subject: [PATCH 5/5] Refactor daily stand-up format in sprint planning guidelines --- doc/development/sprint_planning_guidelines.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/doc/development/sprint_planning_guidelines.md b/doc/development/sprint_planning_guidelines.md index 38b21a2a..605066bb 100644 --- a/doc/development/sprint_planning_guidelines.md +++ b/doc/development/sprint_planning_guidelines.md @@ -86,12 +86,10 @@ Integrate learnings from the previous sprint’s retrospective. Ask: ## 6. Daily Stand-up - Engage in the daily asynchronous stand-up using the following format: - ``` - 1. Yesterday: What did you complete? + 1. Yesterday (optional): What did you complete? - Completed tasks/PRs: #xyz, #abc 2. Today: What are you working on? - Current task: #def - Blocked by/Waiting for: (if any) 3. Challenges/Help needed? - Any blockers or risks to discuss - ```