Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
joeldrapper committed Nov 21, 2024
1 parent f02859a commit ce184e8
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,23 @@ 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)

## Maintenance schedule
## Versioning and Maintenance

### Bug fixes
Phlex does not follow semantic versioning. Instead, we use the following scheme:

- 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
```
DISRUPTIVE.INCOMPATIBLE.COMPATIBLE
```

### Security patches
- `DISRUPTIVE`: This is for milestone/announcement releases and/or major changes that are not backwards compatible and will likely require some work to upgrade.
- `INCOMPATIBLE`: This is for changes that are not backwards compatible and may require a little work to upgrade.
- `COMPATIBLE`: This is for bug fixes, new features and security patches that are non-breaking.

- 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.
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 `COMPATIBLE` version:

- every `INCOMPATIBLE` version that was released in the last year;
- the latest `INCOMPATIBLE` version of the latest two `DISRUPTIVE` versions, even if over a year old; and
- the `main` branch in GitHub.

## Prior Art 🎨

Expand Down

0 comments on commit ce184e8

Please sign in to comment.