Skip to content

Added a short description of versioning for users #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 7, 2023

Conversation

vitcpp
Copy link
Contributor

@vitcpp vitcpp commented Aug 4, 2023

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 vitcpp force-pushed the readme-versioning-update branch from a43fa9c to 2a71248 Compare August 4, 2023 20:44
README.pg_sphere Outdated

VERSIONING:

Stable versions are marked with tags containing version numbers. Each stable
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change "Stable versions are marked with tags containing version numbers" to "Stable versions are marked with tags containing version numbers in the GitHub repository at https://github.com/postgrespro/pgsphere/".

Reason: Someone might download a tarball release or fork the repository and not have the context of where these tags can be found.

README.pg_sphere Outdated

The master branch is intended for development purposes and may contain
intermediate changes. The current version in the master branch as well as its
functionality is the subject to change.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change "is the subject to change" to "are subject to change".

README.pg_sphere Outdated
a newest version using 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 as well as its
Copy link
Contributor

@esabol esabol Aug 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change "master branch as well as its" to "master branch and its". The "as well as" expression would need commas before and after it, and I think just saying "and" is more succinct (and avoids the need for commas).

@vitcpp
Copy link
Contributor Author

vitcpp commented Aug 4, 2023

@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
Copy link
Contributor

esabol commented Aug 4, 2023

@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 vitcpp force-pushed the readme-versioning-update branch from 2a71248 to c20c1a6 Compare August 5, 2023 15:26
README.pg_sphere Outdated

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 a newest
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, "a newest" should be "the newest" on this line. Other than that, looks good!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@esabol may be "the latest"?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that works too. It's better.

@vitcpp vitcpp force-pushed the readme-versioning-update branch from c20c1a6 to cd82a4d Compare August 7, 2023 05:27
Copy link
Contributor

@esabol esabol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Thank you, @vitcpp!

@vitcpp
Copy link
Contributor Author

vitcpp commented Aug 7, 2023

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

@vitcpp vitcpp merged commit 651896c into postgrespro:master Aug 7, 2023
@vitcpp vitcpp deleted the readme-versioning-update branch August 7, 2023 06:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants