Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch from SemVer to BreakVer #822

Merged
merged 1 commit into from
Nov 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 🎨

Expand Down
Loading