From ff4c0ea7d0841c6b1485346652c619ba08629c59 Mon Sep 17 00:00:00 2001 From: Manfred Touron <94029+moul@users.noreply.github.com> Date: Sat, 30 Sep 2023 17:50:53 +0200 Subject: [PATCH 1/7] feat: create rigorous-and-deliberate workflow Depends on #27 --- .../workflows/rigorous-and-deliberate.md | 76 +++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 docs/engineering/workflows/rigorous-and-deliberate.md diff --git a/docs/engineering/workflows/rigorous-and-deliberate.md b/docs/engineering/workflows/rigorous-and-deliberate.md new file mode 100644 index 0000000..3d4d92f --- /dev/null +++ b/docs/engineering/workflows/rigorous-and-deliberate.md @@ -0,0 +1,76 @@ +# 🛠 Rigorous & Deliberate Workflow 🛠 + +## Overview + +This document introduces the "Rigorous & Deliberate" workflow, designed for tasks requiring meticulous planning, thorough reviews, and a deliberate pace to ensure the highest quality outcomes. + +## Terminology + +### Review Cycle + +- An iterative process where tasks undergo multiple checks before approval. + +### Auditor + +- An individual responsible for overseeing and verifying task details. + +### Slow-Track + +- A designated path for tasks that need extended research, design, or development time. + +### Quality Gate + +- A checkpoint ensuring tasks meet the set standards. + +## Primitives + +- Multiple Review Cycles. +- A dedicated Auditor for each task. +- Designated Slow-Track tasks. +- Quality Gates at each workflow phase. + +## Ground Rules + +- All tasks undergo at least two Review Cycles. +- Auditors have the final say on task completion and quality. +- Slow-Track tasks aren't subjected to time constraints but need deeper reviews. +- Tasks only proceed after passing the Quality Gate. + +## Stages + +### Research & Design + +- Tasks begin with a thorough research phase, ensuring a solid foundation. +- Once research is complete, design proposals are formulated and reviewed by the Auditor. + +### Development + +- Development starts after design approval. +- Slow-Track designation can be assigned here if needed. +- Regular check-ins with the Auditor ensure the task aligns with the project's objectives. + +### Review & Refinement + +- Tasks undergo multiple Review Cycles, with feedback addressed in each iteration. +- Auditors verify the task's integrity, functionality, and alignment with initial goals. + +### Deployment & Feedback + +- Once the Auditor gives approval, tasks move to deployment. +- A feedback mechanism ensures that any issues post-deployment are addressed in future cycles. + +## Status Updates + +- Updates are given weekly to account for the workflow's extended duration. +- Three key points to address: + 1. Progress since the last update. + 2. Immediate next steps. + 3. Any obstacles or challenges encountered. + +## Definition of Completion + +A task is deemed complete when: + +- It has successfully passed through all stages. +- Received Auditor approval post multiple reviews. +- No outstanding feedback exists that could compromise its quality. From 2417c96cd73e7ff988e72223795584a2cddf94cf Mon Sep 17 00:00:00 2001 From: moul <94029+moul@users.noreply.github.com> Date: Sat, 30 Sep 2023 17:51:42 +0200 Subject: [PATCH 2/7] chore: fixup Signed-off-by: moul <94029+moul@users.noreply.github.com> --- .../workflows/rigorous-and-deliberate.md | 22 +++++++++++++------ 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/docs/engineering/workflows/rigorous-and-deliberate.md b/docs/engineering/workflows/rigorous-and-deliberate.md index 3d4d92f..ff1ecb4 100644 --- a/docs/engineering/workflows/rigorous-and-deliberate.md +++ b/docs/engineering/workflows/rigorous-and-deliberate.md @@ -2,7 +2,9 @@ ## Overview -This document introduces the "Rigorous & Deliberate" workflow, designed for tasks requiring meticulous planning, thorough reviews, and a deliberate pace to ensure the highest quality outcomes. +This document introduces the "Rigorous & Deliberate" workflow, designed for +tasks requiring meticulous planning, thorough reviews, and a deliberate pace to +ensure the highest quality outcomes. ## Terminology @@ -16,7 +18,8 @@ This document introduces the "Rigorous & Deliberate" workflow, designed for task ### Slow-Track -- A designated path for tasks that need extended research, design, or development time. +- A designated path for tasks that need extended research, design, or + development time. ### Quality Gate @@ -41,23 +44,28 @@ This document introduces the "Rigorous & Deliberate" workflow, designed for task ### Research & Design - Tasks begin with a thorough research phase, ensuring a solid foundation. -- Once research is complete, design proposals are formulated and reviewed by the Auditor. +- Once research is complete, design proposals are formulated and reviewed by the + Auditor. ### Development - Development starts after design approval. - Slow-Track designation can be assigned here if needed. -- Regular check-ins with the Auditor ensure the task aligns with the project's objectives. +- Regular check-ins with the Auditor ensure the task aligns with the project's + objectives. ### Review & Refinement -- Tasks undergo multiple Review Cycles, with feedback addressed in each iteration. -- Auditors verify the task's integrity, functionality, and alignment with initial goals. +- Tasks undergo multiple Review Cycles, with feedback addressed in each + iteration. +- Auditors verify the task's integrity, functionality, and alignment with + initial goals. ### Deployment & Feedback - Once the Auditor gives approval, tasks move to deployment. -- A feedback mechanism ensures that any issues post-deployment are addressed in future cycles. +- A feedback mechanism ensures that any issues post-deployment are addressed in + future cycles. ## Status Updates From 8909df552722ac1ee0ba2d9874e3625c3916bb4a Mon Sep 17 00:00:00 2001 From: moul <94029+moul@users.noreply.github.com> Date: Sat, 30 Sep 2023 17:57:58 +0200 Subject: [PATCH 3/7] chore: fixup Signed-off-by: moul <94029+moul@users.noreply.github.com> --- .../{rigorous-and-deliberate.md => rigorous-deliberate.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/engineering/workflows/{rigorous-and-deliberate.md => rigorous-deliberate.md} (100%) diff --git a/docs/engineering/workflows/rigorous-and-deliberate.md b/docs/engineering/workflows/rigorous-deliberate.md similarity index 100% rename from docs/engineering/workflows/rigorous-and-deliberate.md rename to docs/engineering/workflows/rigorous-deliberate.md From c0af1529aec0738240a03532f53de54bc7b28bb8 Mon Sep 17 00:00:00 2001 From: moul <94029+moul@users.noreply.github.com> Date: Sat, 30 Sep 2023 18:21:33 +0200 Subject: [PATCH 4/7] chore: fixup Signed-off-by: moul <94029+moul@users.noreply.github.com> --- .../workflows/rigorous-deliberate.md | 119 ++++++++---------- 1 file changed, 53 insertions(+), 66 deletions(-) diff --git a/docs/engineering/workflows/rigorous-deliberate.md b/docs/engineering/workflows/rigorous-deliberate.md index ff1ecb4..ec5e8cb 100644 --- a/docs/engineering/workflows/rigorous-deliberate.md +++ b/docs/engineering/workflows/rigorous-deliberate.md @@ -1,84 +1,71 @@ -# 🛠 Rigorous & Deliberate Workflow 🛠 +## Rigorous & Deliberate Workflow -## Overview +### Overview -This document introduces the "Rigorous & Deliberate" workflow, designed for -tasks requiring meticulous planning, thorough reviews, and a deliberate pace to -ensure the highest quality outcomes. +This guide provides insight into our "Rigorous & Deliberate" workflow, designed for projects and goals that require a meticulous approach and careful scrutiny before merging changes. -## Terminology +### Terminology -### Review Cycle +- **Goal**: A clear and distinct unit of work. Each goal should have enough detail to be self-contained, enabling anyone to understand its scope. +- **Merge Request (MR)**: A request to merge a branch into the main codebase. It includes the changes to be reviewed and, if accepted, merged. +- **Reviewer**: A designated team member responsible for thoroughly inspecting and vetting the changes in the MR. +- **Merge**: The act of integrating approved changes into the main codebase. -- An iterative process where tasks undergo multiple checks before approval. - -### Auditor +### Principles -- An individual responsible for overseeing and verifying task details. - -### Slow-Track +- **Depth Over Speed**: Emphasize comprehensiveness. Inspect each MR deeply to ensure alignment with our standards. +- **Collective Ownership**: The quality of the codebase is everyone's responsibility. Reviewers act as gatekeepers, but all team members must prioritize excellence in their contributions. +- **Iterative Feedback**: Provide constructive and iterative feedback during the review process, allowing the original author to refine and improve their work based on multiple perspectives. -- A designated path for tasks that need extended research, design, or - development time. +### Workflow -### Quality Gate +Of course! I'll restructure and refine the workflow for better clarity and coherence: -- A checkpoint ensuring tasks meet the set standards. +--- -## Primitives +**Goal-Oriented Workflow** +✨ Prioritizing Objectives & Collaboration ✨ -- Multiple Review Cycles. -- A dedicated Auditor for each task. -- Designated Slow-Track tasks. -- Quality Gates at each workflow phase. +**Overview:** +This workflow emphasizes a systematic approach driven by a clearly defined goal, supplemented by regular check-ins, meticulous documentation, and thorough reviews to ensure alignment and quality throughout the development process. -## Ground Rules +**Stages & Steps:** -- All tasks undergo at least two Review Cycles. -- Auditors have the final say on task completion and quality. -- Slow-Track tasks aren't subjected to time constraints but need deeper reviews. -- Tasks only proceed after passing the Quality Gate. +1. **Goal Definition**: + * Identify and articulate a clear goal or objective for the project. +2. **Research & Foundation**: + * Undertake comprehensive research. + * Use findings to establish a robust foundation for subsequent stages. + * Create detailed design proposals based on research and the set goal. + * Submit the design for review to the Auditor to ensure alignment with the overarching goal. +3. **Initiation of Development**: + * Post design approval, begin the development phase. + * Open an early branch and initiate a draft PR, ensuring it's appropriately labeled. +4. **Continuous Updates & Communication**: + * Keep all stakeholders informed by consistently updating relevant documents or files (e.g., PR, issue, doc, .md). + * Provide monthly updates highlighting progress since the last communication, forthcoming steps, and any challenges encountered. + * Schedule regular check-ins with the Auditor. + * This ensures the work remains aligned with the project's objectives and the originally set goal. + * Engage in regular reviews or pair programming sessions. + * Aim for monthly collaborations to share knowledge and enhance code quality. +5. **Documentation**: + * Prioritize comprehensive documentation, especially for intricate tasks. + * Ensure it's clear, detailed, and easily understandable. +6. **Review & Feedback**: + * Appoint a minimum of two reviewers for detailed feedback. + * Their insights ensure quality, functionality, and alignment with the goal. + * Before concluding, the Auditor assesses the project for integrity, functionality, and congruence with the initially set goals. +### Recommendations -## Stages +* **Open Dialogue**: Encourage open communication among team members. Regular discussions can lead to proactive problem-solving and innovation. +* **Adaptable Milestones**: While sticking to the goal is crucial, allow for minor adjustments to milestones based on feedback and unforeseen challenges. +- **Stay Updated**: Always work with the latest version of the main codebase to minimize merge conflicts. +- **Open Communication**: If you're unsure at any stage, communicate. Whether you're the goal owner or a reviewer, open dialogue ensures clarity and quality. -### Research & Design +### Definition of Completion -- Tasks begin with a thorough research phase, ensuring a solid foundation. -- Once research is complete, design proposals are formulated and reviewed by the - Auditor. - -### Development - -- Development starts after design approval. -- Slow-Track designation can be assigned here if needed. -- Regular check-ins with the Auditor ensure the task aligns with the project's - objectives. - -### Review & Refinement - -- Tasks undergo multiple Review Cycles, with feedback addressed in each - iteration. -- Auditors verify the task's integrity, functionality, and alignment with - initial goals. - -### Deployment & Feedback - -- Once the Auditor gives approval, tasks move to deployment. -- A feedback mechanism ensures that any issues post-deployment are addressed in - future cycles. - -## Status Updates - -- Updates are given weekly to account for the workflow's extended duration. -- Three key points to address: - 1. Progress since the last update. - 2. Immediate next steps. - 3. Any obstacles or challenges encountered. - -## Definition of Completion - -A task is deemed complete when: +A goal is considered complete when: - It has successfully passed through all stages. -- Received Auditor approval post multiple reviews. -- No outstanding feedback exists that could compromise its quality. +- It has received Auditor approval after multiple reviews. +- There are no outstanding feedback points that could compromise its quality. \ No newline at end of file From dbd2f690563724d4045dfac059bfaba7d203f934 Mon Sep 17 00:00:00 2001 From: moul <94029+moul@users.noreply.github.com> Date: Sat, 30 Sep 2023 21:44:16 +0200 Subject: [PATCH 5/7] chore: fixup Signed-off-by: moul <94029+moul@users.noreply.github.com> --- .../workflows/rigorous-deliberate.md | 26 +++++-------------- 1 file changed, 7 insertions(+), 19 deletions(-) diff --git a/docs/engineering/workflows/rigorous-deliberate.md b/docs/engineering/workflows/rigorous-deliberate.md index ec5e8cb..333fb06 100644 --- a/docs/engineering/workflows/rigorous-deliberate.md +++ b/docs/engineering/workflows/rigorous-deliberate.md @@ -1,35 +1,23 @@ -## Rigorous & Deliberate Workflow +# Rigorous & Deliberate Workflow -### Overview +## Overview This guide provides insight into our "Rigorous & Deliberate" workflow, designed for projects and goals that require a meticulous approach and careful scrutiny before merging changes. -### Terminology +## Terminology - **Goal**: A clear and distinct unit of work. Each goal should have enough detail to be self-contained, enabling anyone to understand its scope. - **Merge Request (MR)**: A request to merge a branch into the main codebase. It includes the changes to be reviewed and, if accepted, merged. - **Reviewer**: A designated team member responsible for thoroughly inspecting and vetting the changes in the MR. - **Merge**: The act of integrating approved changes into the main codebase. -### Principles +## Principles - **Depth Over Speed**: Emphasize comprehensiveness. Inspect each MR deeply to ensure alignment with our standards. - **Collective Ownership**: The quality of the codebase is everyone's responsibility. Reviewers act as gatekeepers, but all team members must prioritize excellence in their contributions. - **Iterative Feedback**: Provide constructive and iterative feedback during the review process, allowing the original author to refine and improve their work based on multiple perspectives. -### Workflow - -Of course! I'll restructure and refine the workflow for better clarity and coherence: - ---- - -**Goal-Oriented Workflow** -✨ Prioritizing Objectives & Collaboration ✨ - -**Overview:** -This workflow emphasizes a systematic approach driven by a clearly defined goal, supplemented by regular check-ins, meticulous documentation, and thorough reviews to ensure alignment and quality throughout the development process. - -**Stages & Steps:** +## Stages & Steps 1. **Goal Definition**: * Identify and articulate a clear goal or objective for the project. @@ -55,14 +43,14 @@ This workflow emphasizes a systematic approach driven by a clearly defined goal, * Appoint a minimum of two reviewers for detailed feedback. * Their insights ensure quality, functionality, and alignment with the goal. * Before concluding, the Auditor assesses the project for integrity, functionality, and congruence with the initially set goals. -### Recommendations +## Recommendations * **Open Dialogue**: Encourage open communication among team members. Regular discussions can lead to proactive problem-solving and innovation. * **Adaptable Milestones**: While sticking to the goal is crucial, allow for minor adjustments to milestones based on feedback and unforeseen challenges. - **Stay Updated**: Always work with the latest version of the main codebase to minimize merge conflicts. - **Open Communication**: If you're unsure at any stage, communicate. Whether you're the goal owner or a reviewer, open dialogue ensures clarity and quality. -### Definition of Completion +## Definition of Completion A goal is considered complete when: From eaa37a4c1158f11634edc989929ba39cfe29b971 Mon Sep 17 00:00:00 2001 From: moul <94029+moul@users.noreply.github.com> Date: Sat, 30 Sep 2023 21:45:45 +0200 Subject: [PATCH 6/7] chore: fixup Signed-off-by: moul <94029+moul@users.noreply.github.com> --- .../workflows/rigorous-deliberate.md | 58 +++++++++++++------ 1 file changed, 40 insertions(+), 18 deletions(-) diff --git a/docs/engineering/workflows/rigorous-deliberate.md b/docs/engineering/workflows/rigorous-deliberate.md index 333fb06..5e8e821 100644 --- a/docs/engineering/workflows/rigorous-deliberate.md +++ b/docs/engineering/workflows/rigorous-deliberate.md @@ -2,20 +2,30 @@ ## Overview -This guide provides insight into our "Rigorous & Deliberate" workflow, designed for projects and goals that require a meticulous approach and careful scrutiny before merging changes. +This guide provides insight into our "Rigorous & Deliberate" workflow, designed +for projects and goals that require a meticulous approach and careful scrutiny +before merging changes. ## Terminology -- **Goal**: A clear and distinct unit of work. Each goal should have enough detail to be self-contained, enabling anyone to understand its scope. -- **Merge Request (MR)**: A request to merge a branch into the main codebase. It includes the changes to be reviewed and, if accepted, merged. -- **Reviewer**: A designated team member responsible for thoroughly inspecting and vetting the changes in the MR. +- **Goal**: A clear and distinct unit of work. Each goal should have enough + detail to be self-contained, enabling anyone to understand its scope. +- **Merge Request (MR)**: A request to merge a branch into the main codebase. It + includes the changes to be reviewed and, if accepted, merged. +- **Reviewer**: A designated team member responsible for thoroughly inspecting + and vetting the changes in the MR. - **Merge**: The act of integrating approved changes into the main codebase. ## Principles -- **Depth Over Speed**: Emphasize comprehensiveness. Inspect each MR deeply to ensure alignment with our standards. -- **Collective Ownership**: The quality of the codebase is everyone's responsibility. Reviewers act as gatekeepers, but all team members must prioritize excellence in their contributions. -- **Iterative Feedback**: Provide constructive and iterative feedback during the review process, allowing the original author to refine and improve their work based on multiple perspectives. +- **Depth Over Speed**: Emphasize comprehensiveness. Inspect each MR deeply to + ensure alignment with our standards. +- **Collective Ownership**: The quality of the codebase is everyone's + responsibility. Reviewers act as gatekeepers, but all team members must + prioritize excellence in their contributions. +- **Iterative Feedback**: Provide constructive and iterative feedback during the + review process, allowing the original author to refine and improve their work + based on multiple perspectives. ## Stages & Steps @@ -25,15 +35,20 @@ This guide provides insight into our "Rigorous & Deliberate" workflow, designed * Undertake comprehensive research. * Use findings to establish a robust foundation for subsequent stages. * Create detailed design proposals based on research and the set goal. - * Submit the design for review to the Auditor to ensure alignment with the overarching goal. + * Submit the design for review to the Auditor to ensure alignment with the + overarching goal. 3. **Initiation of Development**: * Post design approval, begin the development phase. - * Open an early branch and initiate a draft PR, ensuring it's appropriately labeled. + * Open an early branch and initiate a draft PR, ensuring it's appropriately + labeled. 4. **Continuous Updates & Communication**: - * Keep all stakeholders informed by consistently updating relevant documents or files (e.g., PR, issue, doc, .md). - * Provide monthly updates highlighting progress since the last communication, forthcoming steps, and any challenges encountered. + * Keep all stakeholders informed by consistently updating relevant documents + or files (e.g., PR, issue, doc, .md). + * Provide monthly updates highlighting progress since the last communication, + forthcoming steps, and any challenges encountered. * Schedule regular check-ins with the Auditor. - * This ensures the work remains aligned with the project's objectives and the originally set goal. + * This ensures the work remains aligned with the project's objectives and the + originally set goal. * Engage in regular reviews or pair programming sessions. * Aim for monthly collaborations to share knowledge and enhance code quality. 5. **Documentation**: @@ -42,13 +57,20 @@ This guide provides insight into our "Rigorous & Deliberate" workflow, designed 6. **Review & Feedback**: * Appoint a minimum of two reviewers for detailed feedback. * Their insights ensure quality, functionality, and alignment with the goal. - * Before concluding, the Auditor assesses the project for integrity, functionality, and congruence with the initially set goals. + * Before concluding, the Auditor assesses the project for integrity, + functionality, and congruence with the initially set goals. + ## Recommendations -* **Open Dialogue**: Encourage open communication among team members. Regular discussions can lead to proactive problem-solving and innovation. -* **Adaptable Milestones**: While sticking to the goal is crucial, allow for minor adjustments to milestones based on feedback and unforeseen challenges. -- **Stay Updated**: Always work with the latest version of the main codebase to minimize merge conflicts. -- **Open Communication**: If you're unsure at any stage, communicate. Whether you're the goal owner or a reviewer, open dialogue ensures clarity and quality. +* **Open Dialogue**: Encourage open communication among team members. Regular + discussions can lead to proactive problem-solving and innovation. +* **Adaptable Milestones**: While sticking to the goal is crucial, allow for + minor adjustments to milestones based on feedback and unforeseen challenges. +- **Stay Updated**: Always work with the latest version of the main codebase to + minimize merge conflicts. +- **Open Communication**: If you're unsure at any stage, communicate. Whether + you're the goal owner or a reviewer, open dialogue ensures clarity and + quality. ## Definition of Completion @@ -56,4 +78,4 @@ A goal is considered complete when: - It has successfully passed through all stages. - It has received Auditor approval after multiple reviews. -- There are no outstanding feedback points that could compromise its quality. \ No newline at end of file +- There are no outstanding feedback points that could compromise its quality. From f75737c2d932ee87e02708c1d0a796dbdb566d67 Mon Sep 17 00:00:00 2001 From: moul <94029+moul@users.noreply.github.com> Date: Sat, 30 Sep 2023 22:01:05 +0200 Subject: [PATCH 7/7] chore: fixup Signed-off-by: moul <94029+moul@users.noreply.github.com> --- .../workflows/rigorous-deliberate.md | 30 +++++++++++-------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/docs/engineering/workflows/rigorous-deliberate.md b/docs/engineering/workflows/rigorous-deliberate.md index 5e8e821..0d92f13 100644 --- a/docs/engineering/workflows/rigorous-deliberate.md +++ b/docs/engineering/workflows/rigorous-deliberate.md @@ -1,23 +1,27 @@ # Rigorous & Deliberate Workflow -## Overview +This guide delves into our "Rigorous & Deliberate" workflow, explicitly crafted +for projects and tasks of high complexity, where conventional timelines and +methodologies may not apply. -This guide provides insight into our "Rigorous & Deliberate" workflow, designed -for projects and goals that require a meticulous approach and careful scrutiny -before merging changes. +This workflow is reserved for challenging tasks where the end date might be +nebulous, and the journey to completion can be long and winding – occasionally +spanning up to a year. -## Terminology - -- **Goal**: A clear and distinct unit of work. Each goal should have enough - detail to be self-contained, enabling anyone to understand its scope. -- **Merge Request (MR)**: A request to merge a branch into the main codebase. It - includes the changes to be reviewed and, if accepted, merged. -- **Reviewer**: A designated team member responsible for thoroughly inspecting - and vetting the changes in the MR. -- **Merge**: The act of integrating approved changes into the main codebase. +The focus here is not just on completion but on ensuring the utmost quality and +protection of such tasks. ## Principles +- **Protection & Isolation**: Tasks under this workflow may appear incompatible + or even unfair when juxtaposed with tasks from other, faster workflows. Thus, + it's essential to shield and isolate these tasks to prevent any + misunderstandings or conflicts. +- **Transparency & Communication**: Given the long-term nature of these tasks, + regular communication is paramount. Teammates should always be in the loop, + understanding the progress, challenges, and updates. This consistent + communication acts as a deterrent to potential conflicts or misunderstandings + arising from the unique nature of these tasks. - **Depth Over Speed**: Emphasize comprehensiveness. Inspect each MR deeply to ensure alignment with our standards. - **Collective Ownership**: The quality of the codebase is everyone's