postgrespro / pgsphere

PgSphere provides spherical data types, functions, operators, and indexing for PostgreSQL.
https://pgsphere.org
BSD 3-Clause "New" or "Revised" License
16 stars 15 forks source link

Added a short description of versioning for users #46

Closed vitcpp closed 11 months ago

vitcpp commented 11 months ago

There is the first attempt to add some simple description of pgsphere versioning for users. Here we state that the master branch is for development purposes and releases are marked with tags. More detailed explanation of versioning for developers I propose to put into CONTRIBUTING.md.

vitcpp commented 11 months ago

@esabol Thank you very much! You may correct and put the complete text in a new comment here if it is simpler for you (or create your PR). My idea is to introduce some statements in README about master branch and tags in according on our agreements on the versioning. Tomorrow I will do corrections.

esabol commented 11 months ago

@esabol Thank you very much! You may correct and put the complete text in a new comment here if it is simpler for you (or create your PR).

I think it's more a question of what's easier for you. Here is the complete text with the changes I have proposed (and a couple of additional ones):

"Stable versions are marked with tags containing version numbers in the GitHub repository at https://github.com/postgrespro/pgsphere/. Each stable version contains upgrade scripts for updating an existing installation to the newest version using the ALTER EXTENSION UPDATE TO command.

The master branch is intended for development purposes and may contain intermediate changes. The current version in the master branch and its functionality are subject to change."

vitcpp commented 11 months ago

@esabol Thank you for your help! Once it doesn't touch the code, I will merge it right now.