Update HISTORY.md #2777
Update HISTORY.md #2777
Conversation
|
@CodeRabbit full review |
|
@coderabbitai full review |
Actions performedFull review triggered. |
WalkthroughThe Changes
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
Documentation and Community
|
![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 (4)
packages/xrpl/HISTORY.md (4)
Line range hint
1-3: Documentation structure needs improvement.The file header could be enhanced by adding:
- A brief description of what xrpl.js is
- Links to the main documentation
- Instructions for subscribing to release announcements
# xrpl.js Release History + # xrpl.js Release History + + xrpl.js is the official JavaScript/TypeScript library for interacting with the XRP Ledger. + + - [Documentation](https://js.xrpl.org) + - [GitHub Repository](https://github.com/XRPLF/xrpl.js) + Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xrpl-announce) for release announcements.
Line range hint
50-60: Security-related changes need more visibility.The security-related changes in version 3.0.0 around cryptographic dependencies should be highlighted more prominently.
Consider adding a dedicated "Security" section at the top of each release that contains security-related changes:
## 3.0.0 (2024-02-01) + ### Security Changes + * Improved cryptographic security by: + - Replacing legacy crypto dependencies with modern alternatives + - Switching to @noble/hashes and @noble/curves + - Updating key algorithm detection with better error messages + ### BREAKING CHANGES * The default signing algorithm in the `Wallet` was changed from secp256k1 to ed25519
Line range hint
1-1000: Version history organization could be improved.The changelog would benefit from a more consistent structure across versions and clearer categorization of changes.
Consider adopting a standardized format for all versions:
## x.y.z (YYYY-MM-DD) ### Security (if applicable) - Security-related changes ### Breaking Changes (if applicable) - List of breaking changes ### Features - New features ### Bug Fixes - Bug fixes ### Deprecations - Deprecated features ### Documentation - Documentation changes ### Internal - Internal changes, refactoring
Line range hint
1-1000: Deprecation notices need better tracking.The changelog contains multiple deprecation notices but lacks a consolidated view of currently deprecated features.
Add a "Currently Deprecated Features" section at the top of the file:
# xrpl.js Release History ## Currently Deprecated Features | Feature | Deprecated Since | Remove In | Alternative | |---------|-----------------|-----------|-------------| | BroadcastClient | 2.2.2 | TBD | Use reliable connection handling | | Wallet.fromMnemonic() | 2.7.0 | TBD | Use new mnemonic handling | | (Add other deprecated features) | ## Version History (rest of the changelog)
High Level Overview of Change
Context of Change
Type of Change
Did you update HISTORY.md?
Test Plan