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

chore: move upgrading section and remove empty package #18223

Merged
merged 1 commit into from
Oct 23, 2023
Merged

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Oct 23, 2023

Description

Noticed here: #18222 (comment) that the section was put under unreleased instead of v0.50.

Additionally, removes an empty package that I noticed was present in an earlier PR.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • run make lint and make test
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Summary by CodeRabbit

  • New Feature: We've introduced a "Textual sign mode" to the SDK, designed to produce more user-friendly, readable output. This feature is currently compatible with Ledger devices.
  • Documentation: We've provided detailed instructions on how to enable this new sign mode in both legacy and depinject/app v2 setups. For more information, refer to the linked documentation within the upgrade guide.

This update enhances the user experience by making the output more understandable, thereby increasing the software's intuitiveness.

@julienrbrt julienrbrt requested a review from a team as a code owner October 23, 2023 15:54
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 23, 2023

Walkthrough

This update introduces the "Textual sign mode" to the SDK, enhancing user experience with more readable output. Primarily available on Ledger devices, the update provides instructions for enabling this mode in both legacy and depinject/app v2 applications.

Changes

File(s) Summary
app.go, root.go Added code snippets to enable the new "Textual sign mode" in both legacy and depinject/app v2 applications.
UPGRADING.md Included instructions and relevant documentation links for the new sign mode implementation.

🐇

"In the realm of code, where the rabbits play,

A new sign mode has found its way.

More readable, friendly, and clear,

For all Ledger devices, far and near.

So hop along, let's celebrate this day,

For in the world of code, it's a brighter day!" 🎉


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.json

@github-prbot github-prbot requested review from a team, facundomedica and testinginprod and removed request for a team October 23, 2023 15:54
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0
Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 3c9168d and 15ab7d2.
Files selected for processing (1)
  • UPGRADING.md (2 hunks)
Additional comments (Suppressed): 2
UPGRADING.md (2)
  • 33-37: The changes in this hunk are mostly formatting and do not introduce any new information or changes to the codebase. The section on x/group module is left empty, which might be filled in future commits.

  • 408-454: The changes in this hunk move the "Textual sign mode" section to a more appropriate location in the document. The instructions for enabling the new sign mode in both legacy application wiring and depinject/app v2 are clear and well-documented. The links to further documentation are also helpful. However, it would be beneficial to mention the potential impact of this new sign mode on the existing system or user experience.

@tac0turtle tac0turtle added this pull request to the merge queue Oct 23, 2023
Merged via the queue into main with commit 33183fe Oct 23, 2023
@tac0turtle tac0turtle deleted the julien/chore branch October 23, 2023 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants