Skip to content
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

Add version release notes and unify expressions #2889

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bluayer
Copy link

@bluayer bluayer commented Dec 30, 2024

Description

I've reflected updates and release date on the readme about the content that actual users would find important.
Also, the expressions for the features between the README, release notes, and Wiki were different, so I modified the README to match these parts.

Issue link

This Pull Request is linked to issue (URL): [REPLACE ME]

I've reflected updates and release date on the readme about the content that actual users would find important.

Signed-off-by: bluayer <[email protected]>
@bluayer bluayer requested a review from a team as a code owner December 30, 2024 01:45
@ikolomi ikolomi self-requested a review December 30, 2024 09:16
Copy link
Collaborator

@ikolomi ikolomi left a comment

Choose a reason for hiding this comment

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

@bluayer thanks for this PR.

We want to have description of versions in the readme short and concise.
More information can be found here https://github.com/valkey-io/valkey-glide/releases/tag/v1.2.0

So no need to modify the content, but please kindly change the month to Nov (no need to mention GA) they are all GA in the readme

@bluayer
Copy link
Author

bluayer commented Dec 30, 2024

@ikolomi Thank you for a your comment.
I also know there's information about the release.
If I follow the comment, it seems that the content doesn't need a description of version 1.2, but only a description of the upcoming version 1.3.
1.2 version is in the README, even though it is GA, causes confusion because README also contains information about version 1.3.

Suggestion : How about deleting the content about version 1.2 and adding a link to Release?

@avifenesh
Copy link
Collaborator

@ikolomi I think we can add a section of "last release" or similar to make it clear. Better wordings, probably.

@ikolomi
Copy link
Collaborator

ikolomi commented Dec 30, 2024

@bluayer
We want the readme to contain a short description of the current (1.2) and the upcomming (1.3) releases
Now I see you point of adding the "GA" to 1.2 label. Although it is obvious from the dates, i am OK to have the GA mark

Kindly update your PR

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.

3 participants