From 4648e83c55183101b1eae843fb606da76b8cdcb0 Mon Sep 17 00:00:00 2001 From: eggy Date: Fri, 12 Apr 2024 10:47:11 -0400 Subject: [PATCH] chore: update release guidelines --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index eaf9740..a13ae18 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ Release guidelines: -- The major version represents the current academic year, e.g., both post-2A and 2B would be v2. -- The minor version represents the current academic term, e.g., 2A would be v2.1. the x.0 releases are reserved for beta changes. -- The patch version is incremented for any other reason. +- Increment the major version for every work term, e.g., post-2A (WT2) and post-2B (WT3) would be v2.x.x and v3.x.x, respectively. +- Increment the minor version for every major change. These can include: + - Adding a new section + - Adding a new skill + - Adding/removing a new experience or project + - Substantially rewriting lines across multiple experiences or projects +- Increment the patch version for formatting changes or simple tweaks.