PGPainless/pgpainless
PGPainless
/
pgpainless
mirror of https://github.com/pgpainless/pgpainless.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update README

This commit is contained in:
Paul Schaub 2022-03-15 17:20:55 +01:00
parent 29dc20d0bc
commit 2dba981e07
Signed by: vanitasvitae
GPG Key ID: 62BEE9264BF17311
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -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