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

fix: wrong timeline stage #1619

Merged
merged 1 commit into from
Oct 31, 2024
Merged

Conversation

AMIRKHANEF
Copy link
Member

@AMIRKHANEF AMIRKHANEF commented Oct 29, 2024

Close: #1618

Summary by CodeRabbit

  • New Features

    • Enhanced timeline display for referendum and treasury proposals for improved clarity.
  • Style

    • Adjusted alignment of the timeline header for better visual presentation.

Copy link
Contributor

coderabbitai bot commented Oct 29, 2024

Walkthrough

The changes introduce a new memoized variable timelineStage in the Chronology component, which dynamically determines the display text for the timeline based on the referendum and treasury state. The previous logic for displaying the treasury label has been replaced with this variable, improving code clarity and maintainability. Additionally, the alignment property of a Grid component has been modified from baseline to center, potentially impacting the visual layout of the timeline header, while the overall structure and functionality of the component remain unchanged.

Changes

File Path Change Summary
packages/extension-polkagate/src/fullscreen/governance/post/Chronology.tsx Introduced memoized variable timelineStage for display text; replaced treasury label logic; changed Grid alignment from baseline to center.

Poem

In the land of code where rabbits hop,
A new timelineStage helps us stop.
With clarity bright, the treasury's tale,
Aligning the grid, we set our sail.
Hooray for changes, let’s give a cheer,
For a clearer path, we hold so dear! 🐇✨


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

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.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
packages/extension-polkagate/src/fullscreen/governance/post/Chronology.tsx (1)

125-133: LGTM! Consider adding JSDoc for clarity.

The memoized implementation correctly handles all cases and has proper dependency tracking. Consider adding JSDoc to document the purpose and return value of this computed property.

Add documentation above the useMemo:

/** Returns the current stage of the timeline for display purposes.
 * - For treasury proposals that are executed, shows the treasury label
 * - For proposals with history, shows the latest status or treasury label
 * - Otherwise returns an empty string
 */
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 9440cc9 and 1da71e0.

📒 Files selected for processing (1)
  • packages/extension-polkagate/src/fullscreen/governance/post/Chronology.tsx (2 hunks)
🔇 Additional comments (2)
packages/extension-polkagate/src/fullscreen/governance/post/Chronology.tsx (2)

144-144: LGTM! Improved vertical alignment.

The alignment change from 'baseline' to 'center' improves the visual balance between the Timeline title and stage text.


150-150: LGTM! Clean implementation.

Good use of the memoized value to simplify the template logic while maintaining the same functionality.

@Nick-1979 Nick-1979 merged commit 73fcabf into PolkaGate:main Oct 31, 2024
11 checks passed
@AMIRKHANEF AMIRKHANEF deleted the fixTimelinestgeissue branch October 31, 2024 19:04
github-actions bot pushed a commit that referenced this pull request Oct 31, 2024
## [0.21.2](v0.21.1...v0.21.2) (2024-10-31)

### Bug Fixes

* wrong timeline stage in Governance ([#1619](#1619)) ([73fcabf](73fcabf))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

may show wrong Timeline label
2 participants