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 changelog file #369

Merged
merged 1 commit into from
Apr 27, 2022
Merged

Conversation

tjoubert
Copy link
Contributor

Add changelog file to log project updates.

Add changelog file to log project updates.
@tjoubert tjoubert requested a review from Zyqsempai April 27, 2022 05:07
Copy link
Contributor

@Zyqsempai Zyqsempai left a comment

Choose a reason for hiding this comment

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

LGTM

@Zyqsempai Zyqsempai merged commit cc473b4 into master Apr 27, 2022
Copy link
Collaborator

@DiscoPYF DiscoPYF left a comment

Choose a reason for hiding this comment

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

Adding a changelog is a good idea, esp. with a standard format. However, I think there is something wrong with the versioning here. Let me know what you think.

- `GET/_api/collection/{collection-name}/shards`: Returns the shard ids of a collection
- `PUT/_api/collection/{collection-name}/compact`: Compacts a collection

## [2.00.1] - 2022-03-24
Copy link
Collaborator

@DiscoPYF DiscoPYF Apr 30, 2022

Choose a reason for hiding this comment

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

I'm confused by these version increments. All these changes haven't been release yet, why are they listed under a new version?

In addition, version numbers are usually written with a single digit when less than 10, e.g. 2.0.1. Not a big deal but 2.00.1 looks off to me.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good points @DiscoPYF:

  • We have removed version numbers since we have not yet released these features. We will add the new version 2.0.0 when we release.
  • I agree with using single digits as well when the number is less than 10.

@tjoubert tjoubert mentioned this pull request May 2, 2022
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