chore: Try to extend testing time for our beloved testers. (#937)

kRHYME7 · rubiin · commit 113deccbda60 · 2025-07-10T22:31:15.000+05:45
diff --git a/.github/scripts/promote_to_master.sh b/.github/scripts/promote_to_master.sh
@@ -13,7 +13,7 @@ if [ -z "$COMMIT_LIST" ]; then
     COMMIT_LIST="No new commits - branches may be identical"
 fi
 
-MERGE_DATE="Friday"
+MERGE_DATE="1st or 3rd Friday of the month"
 
 echo "$COMMIT_LIST" >commit_list.txt
 
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -8,7 +8,7 @@ on:
 
 jobs:
   dev-to-master-pr:
-    name: Create or Update PR from Dev to Master
+    name: Create Quarterly Release PR from Dev to Master
     if: github.ref == 'refs/heads/dev' && github.repository == 'HyDE-Project/HyDE'
     runs-on: ubuntu-latest
     steps:
@@ -64,7 +64,7 @@ jobs:
           script: |
             const { repo, owner } = context.repo;
             const prBranch = "dev";
-            const prTitle = "chore: release automated changes from dev to master";
+            const prTitle = "chore: quarterly release - dev → master";
             const prBody = process.env.PR_BODY;
 
             // Retry helper function
@@ -140,7 +140,7 @@ jobs:
           echo "The branches master and dev are already in sync."
 
   release:
-    name: release
+    name: Quarterly Snapshot Release
     if: github.ref == 'refs/heads/master' && github.repository == 'HyDE-Project/HyDE'
     runs-on: ubuntu-latest
     steps:
diff --git a/.github/workflows/refresh-release.yml b/.github/workflows/refresh-release.yml
@@ -1,4 +1,4 @@
-name: Refresh Release
+name: Quarterly Release Refresh
 
 on:
   workflow_dispatch:
@@ -49,4 +49,4 @@ jobs:
           git push origin HEAD:master
 
       - name: Provide feedback
-        run: echo "Release refresh triggered successfully with a ${{ github.event.inputs.version_bump }} version bump!"
+        run: echo "Quarterly release refresh triggered successfully with a ${{ github.event.inputs.version_bump }} version bump!"
diff --git a/.github/workflows/warn-master-pr.yml b/.github/workflows/warn-master-pr.yml
@@ -61,7 +61,7 @@ jobs:
                 owner,
                 repo,
                 issue_number,
-                body: "⚠️ **Warning: PR targeting master branch detected!**\n\n**This PR is targeting `master` but should target `dev` instead.**\n\nAccording to our [CONTRIBUTING.md](https://github.com/HyDE-Project/HyDE/blob/master/CONTRIBUTING.md) and [RELEASE_POLICY.md](https://github.com/HyDE-Project/HyDE/blob/master/RELEASE_POLICY.md):\n\n- **All pull requests must be submitted to the `dev` branch**\n- Changes go through `dev` first for testing before being merged to `master` during release windows\n- **PRs to `master` are only allowed for emergencies**\n\n**Required Action:**\n1. **Change the base branch from `master` to `dev`**\n2. Follow the [pull request template](https://github.com/HyDE-Project/HyDE/blob/master/.github/PULL_REQUEST_TEMPLATE.md)\n\n**If this is an emergency fix, please add a comment explaining why it needs to target `master` directly.**\n\n---\n*This is an automated message enforcing our contribution workflow.*"
+                body: "⚠️ **Warning: PR targeting master branch detected!**\n\n**This PR is targeting `master` but should target `dev` instead.**\n\nAccording to our [Quarterly Release Policy](https://github.com/HyDE-Project/HyDE/blob/master/RELEASE_POLICY.md):\n\n- **All pull requests must be submitted to the `dev` branch**\n- Changes go through `dev` first for testing before being merged to `master` during quarterly release windows (1st & 3rd Fridays)\n- **PRs to `master` are only allowed for emergencies**\n\n**Required Action:**\n1. **Change the base branch from `master` to `dev`**\n2. Follow the [pull request template](https://github.com/HyDE-Project/HyDE/blob/master/.github/PULL_REQUEST_TEMPLATE.md)\n\n**If this is an emergency fix, please add a comment explaining why it needs to target `master` directly.**\n\n---\n*This is an automated message enforcing our quarterly release workflow.*"
               });
               console.log('Warning comment added to PR #' + issue_number);
             } else {
diff --git a/RELEASE_POLICY.md b/RELEASE_POLICY.md
@@ -1,64 +1,200 @@
-## Release & Branching Policy (Flexible Freeze & Release Window)
+## Release & Branching Policy - Quarterly Releases
 
-### Branches
+#### Three Key Points
 
-- **`dev` branch**  
-  Active development branch where all new features and fixes are merged and tested continuously.
+1. **Development** - All development and PRs target`dev`
+2. **Release** - Merge`dev` →`master` twice per month (1st Quarter & 3rd Quarter)
+3. **Snapshot** - Create official releases from stable`master` branch---
 
-- **`master` branch**  
-  Stable production branch updated only with thoroughly tested code from `dev`.
+---
+
+## Quarterly Release Schedule Flow
+
+- **1st Quarter (1st Friday):** Merge`dev` →`master` → Snapshot release (2nd Friday)
+- **3rd Quarter (3rd Friday):** Merge`dev` →`master` → Snapshot release (4th Friday)
+
+
+#### 1st Quarter Cycle
+
+**Week before 1st Friday:**
+
+- 🚫**Dev freeze** - No new PRs merged to`dev` (fixes only)
+- 🧪**Testing phase** - Focus on validation and bug fixes
+
+**1st Friday:**
+
+- 🔄**Merge `dev` → `master`**
+- ✅**Dev reopens** - New features and PRs accepted
+
+**2nd Friday:**
+
+- 📦**Snapshot release** (when`master` is stable)
+
+#### 3rd Quarter Cycle
+
+**Week before 3rd Friday:**
 
-- **`release` branch**
-  Freezed production `master` branch for release. This branch is not updated with new features or fixes. This just serves as a snapshot of the production code.
+- 🚫**Dev freeze** - No new PRs merged to`dev` (fixes only)
+- 🧪**Testing phase** - Focus on validation and bug fixes
 
-### Weekly Release Cycle (Flexible Timing)
+**3rd Friday:**
 
-- **Dev Branch Freeze Window:**  
-  The `dev` branch freeze typically occurs **during the latter part of the week (Wednesday/Thursday)**, allowing no new feature merges after that point. Only critical bug fixes and final testing are allowed during this freeze period.
+- 🔄**Merge `dev` → `master`**
+- ✅**Dev reopens** - New features and PRs accepted
 
-- **Merge & Release Window:**  
-  The merge from `dev` to `master` and deployment to production happens **on Friday**.
+**4th Friday:**
 
-- **Freeze & Release Window:**  
-  The freeze and release window is we can freeze and tag the `master` branch. Cycles should be first and third week per month.
+- 📦**Snapshot release** (when`master` is stable)
+- 🔄**Preparation for next cycle/month**
 
-### Development and Testing
+#### Summary
 
-- **Monday to Wednesday (before freeze):**  
-  Developers merge features and fixes into `dev`. Testers validate continuously.
+| Quarter               | Freeze Week         | Merge Friday | Snapshot Friday | Dev Status |
+| --------------------- | ------------------- | ------------ | --------------- | ---------- |
+| **1st Quarter** | Week before 1st Fri | 1st Friday   | 2nd Friday      | 🚫→✅     |
+| **3rd Quarter** | Week before 3rd Fri | 3rd Friday   | 4th Friday      | 🚫→✅     |
 
-- **Thursday (freeze window):**  
-  Development freezes on `dev` at some point during the day. Testers focus on final validation and regression testing.
 
-- **Friday (release window):**  
-  Once `dev` is stable and approved, it is merged into `master` and deployed. This happens sometime during Friday, with flexibility to ensure quality.
+**Key Rules:**
 
-- **Friday to Sunday:**  
-  Production monitoring and hotfix as needed.
+- 🚫**Freeze weeks:** No new features to`dev` (fixes only)
+- ✅**Open weeks:** All development welcomed
+- 📦**Snapshots:** Only when`master` is stable
+- 🔄**4th Friday:** Preparation for next cycle/month
 
-### Pull Requests
+---
+
+## Weekly Summary
 
-- All pull requests should be made against `dev` branch.
-- Pull requests should be reviewed and approved by at least one other developer before merging.
-- Pull requests should be merged and deployed within the release window for `master` branch.
-- Pull requests should not be merged directly into `master` branch.
-- Pull request can be created anytime, but should be reviewed and and should be merged to `dev` branch before releasing on `master` branch.
+| Phase                                           | Dev Branch Status   | Allowed Changes                                                     | Description               |
+| ----------------------------------------------- | ------------------- | ------------------------------------------------------------------- | ------------------------- |
+| **Freeze Week** (before 1st & 3rd Friday) | 🚫**FROZEN**  | ❌ No new features `<br>`✅ Bug fixes `<br>`✅ Non-breaking QoL | Testing and validation    |
+| **Merge Friday** (1st & 3rd of month)     | 🔄**MERGING** | 🔄 Merge to master                                                  | Deploy stable code        |
+| **Stabilization Week** (after merge)      | ✅**OPEN**    | ✅ All development `<br>`🔧 Critical hotfixes                     | Monitor master & develop  |
+| **Snapshot Release**                      | 📦**RELEASE** | 📦 Create release                                                   | When `master` is stable |
+
+---
 
-### Summary Timeline (Flexible)
+## Monthly Timeline
 
-| Day                              | Activity                                               |
-| -------------------------------- | ------------------------------------------------------ |
-| Monday–Wednesday (before freeze) | Active development and testing on `dev` branch         |
-| Thursday (freeze window)         | Freeze `dev` branch at flexible time; finalize testing |
-| Friday (release window)          | Merge `dev` into `master` and deploy at flexible time  |
-| Friday–Sunday                    | Monitor production and prepare hotfixes if needed      |
+| Period                                   | Dev Status                | Master Status          | Activity                    | Focus                  |
+| ---------------------------------------- | ------------------------- | ---------------------- | --------------------------- | ---------------------- |
+| **Week before 1st Friday**         | 🚫**FROZEN**        | 🔧 Previous fixes      | Testing & validation        | 🧪 Prepare for merge   |
+| **1st Friday**                     | 🔄**MERGING**       | 📥 Receives new code   | Merge `dev` → `master` | 🔄 Deploy              |
+| **Week after 1st Friday**          | ✅**OPEN**          | 🔧 Hotfixes only       | Active development          | � New features to dev |
+| **2nd Friday**                     | �**FREEZE begins** | �📦**SNAPSHOT** | Release when stable         | 📦 Release             |
+| **Week before 2nd-to-last Friday** | 🚫**FROZEN**        | 🔧 Minor fixes only    | Testing & validation        | 🧪 Prepare for merge   |
+| **2nd-to-last Friday**             | 🔄**MERGING**       | 📥 Receives new code   | Merge `dev` → `master` | 🔄 Deploy              |
+| **Week after 2nd-to-last Friday**  | ✅**OPEN**          | 🔧 Hotfixes only       | Active development          | � New features to dev |
+| **Last Friday**                    | �**FREEZE begins** | 📦**SNAPSHOT**   | Release when stable         | 📦 Release             |
+
+**Freeze periods: ~2 weeks per month (handles variable month lengths)**
 
 ---
 
-### Notes
+## Versioning
+
+We use **year.month.quarter** format (`vYY.M.Q`) instead of traditional semantic versioning for several reasons:
+
+- **Release-cycle aligned:** Matches our quarterly release schedule perfectly
+- **Time-based clarity:** Instantly shows when a release was made
+- **Predictable progression:** Always`.1` then`.3` each month
+- **No arbitrary numbers:** No confusion about what constitutes "major" vs "minor"
+- **User-friendly:** Easy to understand -`v25.7.1` = "July 2025, 1st Quarter"
+
+---
+
+## Pull Requests
+
+- All pull requests should be made against`dev` branch
+- Pull requests should be reviewed and approved by at least one other developer before merging
+- Pull requests can be created anytime, but should be merged to`dev` branch before releasing on`master` branch
+- Pull requests should not be merged directly into`master` branch
+- Pull requests should be merged within the release window for`master` branch
+
+---
 
-- The freeze and release times are **flexible within late Wednesday and Friday** to accommodate testing needs and ensure release quality.
-- Aim to freeze `dev` as early as possible on Wednesday and release early on Friday, but timing may adjust based on readiness.
-- Clear communication will be provided each week about the expected freeze and release times. Expect that it may be in the commit messages or in a dedicated discord channel.
-- This is yet experimental and may be adjusted or modified based on feedback and testing results.
-- We don't have exact time frames as it depends on the collaborators availability.
+# FLOWCHART 
+
+Here are some visuals to help you understand the flowchart better.
+
+## Development Flow
+
+```mermaid
+graph TD
+    A[Normal Development<br/>✅ All PRs to dev] --> B{Week Before<br/>1st/3rd Friday?}
+    B -->|Yes| C[🚫 DEV FREEZE<br/>Bug fixes only<br/>🧪 Testing Phase]
+    B -->|No| A
+    
+    C --> D[🔄 MERGE DAY<br/>1st/3rd Friday<br/>dev → master]
+    D --> E[✅ DEV REOPENS<br/>New features accepted]
+    E --> F[📦 SNAPSHOT RELEASE<br/>2nd/4th Friday<br/>When master stable]
+    F --> G[🔄 Prep Next Cycle]
+    G --> A
+    
+    style A fill:#a9b1d6,stroke:#252737,stroke-width:2px,color:#252737
+    style C fill:#ebbcba,stroke:#252737,stroke-width:2px,color:#252737
+    style D fill:#a9b1dc,stroke:#252737,stroke-width:2px,color:#252737
+    style E fill:#a9b1d6,stroke:#252737,stroke-width:2px,color:#252737
+    style F fill:#c79bf0,stroke:#252737,stroke-width:2px,color:#252737
+    style G fill:#ebbcba,stroke:#252737,stroke-width:2px,color:#252737
+```
+
+
+## Branch Flow
+
+
+```mermaid
+graph LR
+    subgraph "Dev Branch"
+        DEV[dev branch] --> FREEZE[🚫 FROZEN<br/>fixes only]
+        FREEZE --> MERGE[🔄 MERGING<br/>to master]
+        MERGE --> OPEN[✅ OPEN<br/>all dev]
+        OPEN --> FREEZE
+    end
+    
+    subgraph "Master Branch"
+        MASTER[master branch] --> PREV[🔧 Previous fixes]
+        PREV --> RECEIVE[📥 RECEIVES<br/>new code]
+        RECEIVE --> RELEASE[📦 RELEASE<br/>when stable]
+        RELEASE --> PREV
+    end
+    
+    MERGE -.-> RECEIVE
+    
+    style DEV fill:#252737,stroke:#a9b1d6,stroke-width:2px,color:#a9b1d6
+    style FREEZE fill:#ebbcba,stroke:#252737,stroke-width:2px,color:#252737
+    style MERGE fill:#a9b1dc,stroke:#252737,stroke-width:2px,color:#252737
+    style OPEN fill:#a9b1d6,stroke:#252737,stroke-width:2px,color:#252737
+    style MASTER fill:#252737,stroke:#a9b1d6,stroke-width:2px,color:#a9b1d6
+    style PREV fill:#c79bf0,stroke:#252737,stroke-width:2px,color:#252737
+    style RECEIVE fill:#a9b1dc,stroke:#252737,stroke-width:2px,color:#252737
+    style RELEASE fill:#a9b1d6,stroke:#252737,stroke-width:2px,color:#252737
+```
+
+## Quarterly Release Schedule
+
+```mermaid
+gantt
+    title Quarterly Release Schedule
+    dateFormat  X
+    axisFormat %d
+    
+    section Week 1
+    🚫 Dev Freeze    :freeze1, 1, 7d
+    🧪 Testing       :test1, 1, 7d
+    
+    section Week 2
+    🔄 Merge Friday  :merge1, 8, 1d
+    📦 Snapshot      :release1, 12, 1d
+    ✅ Dev Open      :open1, 8, 7d
+    
+    section Week 3
+    🚫 Dev Freeze    :freeze2, 15, 7d
+    🧪 Testing       :test2, 15, 7d
+    
+    section Week 4
+    🔄 Merge Friday  :merge2, 22, 1d
+    📦 Snapshot      :release2, 26, 1d
+    ✅ Dev Open      :open2, 22, 7d
+```
