-
Notifications
You must be signed in to change notification settings - Fork 94
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
4.0.0 release #783
4.0.0 release #783
Conversation
WalkthroughThe pull request updates the Changes
Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (4)
CHANGELOG.md (4)
Line range hint
13-15
: Enhance documentation for new featuresConsider the following improvements:
- Add a link to the XLS-33 specification for the MPT amendment
- Provide a brief explanation of the
include_deleted
parameter's purpose and usage in theledger_entry
requestExample:
### Added - Support for the Multi-Purpose Tokens (MPT) amendment ([XLS-33](https://github.com/XRPLF/XRPL-Standards/discussions/XLS-33)) - Add `include_deleted` to ledger_entry request (allows retrieval of deleted ledger entries)
Line range hint
17-18
: Add migration guidance for Python 3.7 usersThe breaking change removing Python 3.7 support should include:
- Migration steps for users on Python 3.7
- Specific dependency conflicts that necessitated this change
- Minimum required version of Python 3.8
Example:
### BREAKING CHANGE: - Remove Python 3.7 support to fix dependency installation and use 3.8 as new default. + - Remove Python 3.7 support and require Python 3.8+ due to dependency conflicts with library X. + - If you're using Python 3.7, upgrade to Python 3.8.0 or later + - Update your CI/CD pipelines and development environments accordingly + - Verify compatibility with your existing dependencies
Line range hint
20-21
: Clarify impact of FeeSettings changesThe fix for FeeSettings values should include:
- The impact on existing applications that might rely on the 10 drops default
- Whether this change affects transaction fee calculation
- Any required updates to application configurations
Example:
### Fixed - Grab the FeeSettings values from the latest validated ledger. Remove hard-coded reference to 10 drops as the reference transaction cost. + - Grab the FeeSettings values from the latest validated ledger instead of using hard-coded 10 drops as the reference transaction cost. + - This may affect transaction fee calculations in your application + - Update your fee estimation logic if you were relying on the 10 drops default + - Monitor your transaction costs as they may vary based on network conditions
8-8
: Consider removing empty Unreleased sectionThe
[Unreleased]
section is empty. Consider either:
- Removing it if there are no unreleased changes, or
- Moving the 4.0.0 changes to this section if they haven't been released yet
This helps maintain a clean and accurate changelog.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CHANGELOG.md
(1 hunks)
🔇 Additional comments (1)
CHANGELOG.md (1)
10-11
: Verify the release date
The release date is set to December 16, 2024, which is in the future. Please confirm if this is intentional or if it should be adjusted to the actual release date.
High Level Overview of Change
Context of Change
Type of Change
Did you update CHANGELOG.md?
Test Plan