Skip to content

Commit

Permalink
docs: add versioning scheme to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Tochemey committed Sep 24, 2024
1 parent c425634 commit 56fbf88
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,16 @@ func (a *AccountBehavior) HandleEvent(_ context.Context, event ego.Event, priorS

```

## Versioning

The version system adopted in eGo deviates a bit from the standard semantic versioning system.
The version format is as follows:

- The `MAJOR` part of the version will stay at `v3` for the meantime.
- The `MINOR` part of the version will cater for any new _features_, _breaking changes_ with a note on the breaking changes.
- The `PATCH` part of the version will cater for dependencies upgrades, bug fixes, security patches and co.

The versioning will remain like `v3.x.x` until further notice.

### Contribution

Expand Down

0 comments on commit 56fbf88

Please sign in to comment.