From 6ddbd05f57d54956580c52ffa0dfa0c582afb628 Mon Sep 17 00:00:00 2001 From: Joel Drapper Date: Thu, 21 Nov 2024 14:21:36 +0000 Subject: [PATCH] Update README.md --- CHANGELOG.md | 2 -- README.md | 19 ++++++++----------- 2 files changed, 8 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d81c77ad..e96981e1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,5 @@ # Changelog -All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). - ## [1.10.0] 2024-04-05 - [Added] new `Phlex::CSV` class for streaming CSV views diff --git a/README.md b/README.md index 75c2b400..87df6923 100644 --- a/README.md +++ b/README.md @@ -2,21 +2,18 @@ Phlex lets you compose web views in pure Ruby. -- [1.0 Stable Docs](https://www.phlex.fun) -- [2.0 Beta Docs](https://beta.phlex.fun) +- [v1 Stable Docs](https://www.phlex.fun) +- [v2 Beta Docs](https://beta.phlex.fun) -## Maintenance schedule +## Versioning and Maintenance -### Bug fixes +Phlex does not follow semantic versioning (SemVer). Instead, we follow [BreakVer](https://www.taoensso.com/break-versioning). -- Only the latest minor version of each major version will receive bug fixes -- We may choose to fix bugs by releasing a new minor version rather than patching the existing minor version -- Major versions will stop receiving bug fixes one year after the next major version is released +When a security issue is brought to our attention, we aim to release patches as soon as possible. We aim to patch with a new `non-breaking` version: -### Security patches - -- When a security issue is brought to our attention, we aim to release patches for any minor version that was released in the last year. -- Additionally, the latest minor version of the latest major version will receive security patches, even if that version is over a year old. +- every `major` version that was released in the last year; +- the latest `minor` version of the latest two `major` versions, even if over a year old; and +- the `main` branch in GitHub. ## Prior Art 🎨