Skip to content

Commit 56fbf88

Browse files
committed
docs: add versioning scheme to readme
1 parent c425634 commit 56fbf88

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

Diff for: readme.md

+10
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,16 @@ func (a *AccountBehavior) HandleEvent(_ context.Context, event ego.Event, priorS
216216

217217
```
218218

219+
## Versioning
220+
221+
The version system adopted in eGo deviates a bit from the standard semantic versioning system.
222+
The version format is as follows:
223+
224+
- The `MAJOR` part of the version will stay at `v3` for the meantime.
225+
- The `MINOR` part of the version will cater for any new _features_, _breaking changes_ with a note on the breaking changes.
226+
- The `PATCH` part of the version will cater for dependencies upgrades, bug fixes, security patches and co.
227+
228+
The versioning will remain like `v3.x.x` until further notice.
219229

220230
### Contribution
221231

0 commit comments

Comments
 (0)