From 2dba981e075c79085c1d58856d85c2d18222f8b7 Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Tue, 15 Mar 2022 17:20:55 +0100 Subject: [PATCH] Update README --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 933ba781..a4157c6d 100644 --- a/README.md +++ b/README.md @@ -208,6 +208,23 @@ PGPainless is developed in - and accepts contributions from - the following plac * [Github](https://github.com/pgpainless/pgpainless) * [Codeberg](https://codeberg.org/PGPainless/pgpainless) +We are using SemVer (MAJOR.MINOR.PATCH) versioning, although MINOR releases could contain breaking changes from time to time. + +If you want to contribute a bug fix, please check the `release/X.Y` branches first to see, what the oldest release is +which contains the bug you are fixing. That way we can update older revisions of the library easily. + +### Branches +* `release/X.Y` contains the state of the latest `X.Y.Z` PATCH release + next PATCH snapshot definition. +* `master` contains the state of the latest MINOR release + some smaller changes that will make it into the next PATCH release. +* `development` contains new features that will make it into the next MINOR release. + +#### Example: +Latest release: 1.1.3 +* `release/1.0` contains the state of `1.0.5-SNAPSHOT` +* `release/1.1` contains the state of `1.1.4-SNAPSHOT` +* `master` contains the state `release/1.1` plus patch level changes that will make it into `1.1.4`. +* `development` contains the state which will at some point become `1.2.0`. + Please follow the [code of conduct](CODE_OF_CONDUCT.md) if you want to be part of the project. ## Acknowledgements