search

onflow / flow-jvm-sdk

Flow JVM SDK
Apache License 2.0
16 stars 16 forks source link

README summarizing breaking changes #81

Closed lealobanov closed 2 months ago

lealobanov commented 2 months ago

Description

For contributor use:

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

[!WARNING]

Rate limit exceeded

@lealobanov has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 27 minutes and 55 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 861c9e331db5622e1c26ace1e0d9feb8eddb159e and b7083ac878f220ef926f1d17c8071dbdf9bcd7d6.

Walkthrough

The recent changes to the SDK introduce a BREAKING_CHANGES.md file that outlines significant updates, including a new structure for API call responses and a refactored ECDSA signing implementation. Developers are informed of deprecated features and improvements to error handling, enhancing clarity and usability. Additionally, updates to the README.md ensure users are aware of breaking changes and have access to accurate contributing resources.

Changes

File(s) Change Summary
BREAKING_CHANGES.md Introduced to document significant breaking changes, including new response handling and ECDSA updates.
README.md Added reference to BREAKING_CHANGES.md and updated the contributing guide URL for accuracy.

Poem

In the garden of code, changes bloom bright,
With responses now clear, coding feels right. 🌼
ECDSA's dance, a refined little step,
Developers cheer, no need for a prep!
So hop with delight, let’s code and explore,
In this vibrant new world, there’s always more! 🐇✨

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?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 2 months ago

SDK Examples Unit Test Results

1 files  1 suites   16s :stopwatch: 3 tests 0 :heavy_check_mark: 0 :zzz: 3 :x:

For more details on these failures, see this check.

Results for commit b7083ac8.

:recycle: This comment has been updated with latest results.

github-actions[bot] commented 2 months ago

Common Integration Test Results

0 files  0 suites   0s :stopwatch: 0 tests 0 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit b7083ac8.

:recycle: This comment has been updated with latest results.

github-actions[bot] commented 2 months ago

Unit Test Results

  53 files  ±0    53 suites  ±0   23s :stopwatch: ±0s 310 tests ±0  310 :heavy_check_mark: ±0  0 :zzz: ±0  0 :x: ±0 

Results for commit ebb77cbb. ± Comparison against base commit d857ae64.

:recycle: This comment has been updated with latest results.

github-actions[bot] commented 2 months ago

Integration Test Results

  5 files  ±0    5 suites  ±0   2m 29s :stopwatch: ±0s 29 tests ±0  29 :heavy_check_mark: ±0  0 :zzz: ±0  0 :x: ±0 

Results for commit ebb77cbb. ± Comparison against base commit d857ae64.

:recycle: This comment has been updated with latest results.