Update CHANGELOG.md for v0.5.2 #914
Conversation
WalkthroughThe pull request introduces updates to the Yorkie JS SDK, specifically reflecting the new version 0.5.2 in the Changes
Possibly related PRs
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
CHANGELOG.md (2)
14-14: Consider adding more details about the impact of this changeWhile the change is clearly stated, it would be helpful to add a brief note about the potential impact of updating to ES2020 and replacing Long with bigint. This could include any compatibility considerations or performance improvements.
🧰 Tools
🪛 Markdownlint
14-14: null
Bare URL used(MD034, no-bare-urls)
14-14: Fix bare URL in GitHub pull request linkThe static analysis tool flagged a bare URL usage. While this is consistent with the rest of the changelog, it's a good practice to use proper Markdown link syntax for better compatibility and readability.
Consider updating the link to use proper Markdown syntax:
-- Update target to ES2020 and replace Long with bigint by @hackerwins in https://github.com/yorkie-team/yorkie-js-sdk/pull/912 ++ Update target to ES2020 and replace Long with bigint by @hackerwins in [#912](https://github.com/yorkie-team/yorkie-js-sdk/pull/912)🧰 Tools
🪛 Markdownlint
14-14: null
Bare URL used(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (3)
- CHANGELOG.md (1 hunks)
- MAINTAINING.md (1 hunks)
- packages/sdk/package.json (1 hunks)
✅ Files skipped from review due to trivial changes (2)
- MAINTAINING.md
- packages/sdk/package.json
🧰 Additional context used
🪛 Markdownlint
CHANGELOG.md
14-14: null
Bare URL used(MD034, no-bare-urls)
🔇 Additional comments (3)
CHANGELOG.md (3)
10-14: LGTM: New version entry added correctlyThe new version entry for 0.5.2 has been added correctly, following the established format of the changelog. The date is included, and the changes are categorized under "Changed".
🧰 Tools
🪛 Markdownlint
14-14: null
Bare URL used(MD034, no-bare-urls)
Line range hint
1-1024: Overall, the CHANGELOG.md is well-maintained and up-to-dateThe changelog is consistently formatted and provides a clear history of changes to the Yorkie JS SDK. The new entry for version 0.5.2 has been added correctly, and the overall structure follows the Keep a Changelog format. Consider adding more details about the impact of the ES2020 and bigint changes, and updating the URL format for better Markdown compatibility.
🧰 Tools
🪛 Markdownlint
14-14: null
Bare URL used(MD034, no-bare-urls)
14-14: Verify the GitHub pull request linkIt's a good practice to ensure that the provided GitHub link is accessible and leads to the correct pull request.
🧰 Tools
🪛 Markdownlint
14-14: null
Bare URL used(MD034, no-bare-urls)
What this PR does / why we need it?
Update CHANGELOG.md for v0.5.2
Any background context you want to provide?
What are the relevant tickets?
Fixes #
Checklist
Summary by CodeRabbit
New Features
Longdata type withbigintfor improved numerical handling.Documentation
MAINTAINING.mddocument.Chores
package.jsonfrom 0.5.1 to 0.5.2.