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: platform ux improvement #6555

Merged
merged 2 commits into from
Feb 6, 2025

Conversation

anmolsinghbhatia
Copy link
Collaborator

@anmolsinghbhatia anmolsinghbhatia commented Feb 5, 2025

Description

This PR includes following changes:

  • Improved list layout indicators.
  • Updated content for section headers in the app sidebar.

Type of Change

  • Improvement (change that would cause existing functionality to not work as expected)

References

[WEB-3319]

Summary by CodeRabbit

  • Style
    • Updated UI text across the platform, simplifying labels for favorites, projects, and workspace for improved clarity.
    • Revised translations in multiple languages to ensure consistent terminology.
  • Refactor
    • Streamlined how epic issue statistics are displayed, ensuring a single, consistent placement in the interface.

Copy link
Contributor

coderabbitai bot commented Feb 5, 2025

Walkthrough

This pull request updates translation keys across multiple locale JSON files by removing redundant possessive prefixes. In the English and Chinese files, the keys "your_favorites" and "your_projects" are renamed to "favorites" and "projects", respectively. For Spanish, French, and Japanese locales, similar modifications remove or replace these keys. Additionally, several web components have been updated: text labels now reflect the new key naming, and the rendering logic within the IssueBlock component has been reorganized to conditionally display IssueStats based on the isEpic prop.

Changes

File(s) Change Summary
packages/i18n/src/locales/{en,es,fr,ja,zh-CN}/translations.json Renamed "your_favorites" to "favorites"; updated or removed "your_projects" key to simplify and standardize translation strings.
web/core/components/workspace/sidebar/{favorites-menu.tsx,projects-list.tsx,workspace-menu-header.tsx} Updated UI labels: changed "YOUR_FAVORITES" to "FAVORITES", revised "your_projects" to "projects", and removed uppercasing in the workspace header label.
web/core/components/issues/issue-layouts/list/block.tsx Reorganized conditional rendering: repositioned rendering of the IssueStats component within the IssueBlock based on the isEpic prop to ensure it is rendered in a single, correct location.

Sequence Diagram(s)

sequenceDiagram
    participant IB as IssueBlock
    participant Tooltip as Tooltip
    participant IS as IssueStats
    participant IP as IssueProperties

    IB->>Tooltip: Render issue name tooltip
    alt Issue is Epic
        IB->>IS: Render IssueStats
    end
    IB->>IP: Render IssueProperties
Loading

Possibly related PRs

Suggested labels

🌟enhancement

Suggested reviewers

  • rahulramesha
  • SatishGandham
  • prateekshourya29

Poem

I'm a rabbit with a code delight,
Hopping through keys both day and night.
Translations trimmed, labels now clear,
A tidy update that brings good cheer.
With every hop, the changes take flight! 🐇

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@anmolsinghbhatia anmolsinghbhatia marked this pull request as ready for review February 5, 2025 16:02
@anmolsinghbhatia anmolsinghbhatia changed the title chore: IssueStats placement updated chore: platform ux improvement Feb 5, 2025
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

🧹 Nitpick comments (4)
web/core/components/issues/issue-layouts/list/block.tsx (1)

149-150: Track the TODO for improving ID/Key width logic.

The current width calculation (projectIdentifier?.length ?? 0) * 7) is a basic approximation. This should be tracked for improvement to ensure consistent and accurate width calculations.

Would you like me to create an issue to track this TODO for improving the ID/Key width logic?

packages/i18n/src/locales/ja/translations.json (1)

170-171: Consistent Key Renaming & Removal.
The translation key "your_favorites" has been replaced with "favorites" and the key "your_projects" has been removed. Please ensure that all UI components referencing favorites or projects are updated accordingly to reflect this change and maintain consistency across all locale files.

packages/i18n/src/locales/es/translations.json (1)

170-171: Streamlined Translation Keys.
The key "your_favorites" is now updated to "favorites" with the value "Favoritos", and the obsolete key "your_projects" has been removed. Verify that these changes are properly integrated in the application UI to avoid any missing translations.

packages/i18n/src/locales/fr/translations.json (1)

170-171: Updated Localization Keys for Clarity.
The revision replaces "your_favorites" with "favorites" (now set to "Favoris") and removes "your_projects", in line with the changes made in other locales. Double-check that the front-end components use these updated keys to ensure a uniform user experience across the application.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 89d1926 and d23424b.

📒 Files selected for processing (9)
  • packages/i18n/src/locales/en/translations.json (1 hunks)
  • packages/i18n/src/locales/es/translations.json (1 hunks)
  • packages/i18n/src/locales/fr/translations.json (1 hunks)
  • packages/i18n/src/locales/ja/translations.json (1 hunks)
  • packages/i18n/src/locales/zh-CN/translations.json (1 hunks)
  • web/core/components/issues/issue-layouts/list/block.tsx (1 hunks)
  • web/core/components/workspace/sidebar/favorites/favorites-menu.tsx (1 hunks)
  • web/core/components/workspace/sidebar/projects-list.tsx (1 hunks)
  • web/core/components/workspace/sidebar/workspace-menu-header.tsx (1 hunks)
✅ Files skipped from review due to trivial changes (5)
  • web/core/components/workspace/sidebar/favorites/favorites-menu.tsx
  • web/core/components/workspace/sidebar/workspace-menu-header.tsx
  • web/core/components/workspace/sidebar/projects-list.tsx
  • packages/i18n/src/locales/en/translations.json
  • packages/i18n/src/locales/zh-CN/translations.json
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (python)
🔇 Additional comments (1)
web/core/components/issues/issue-layouts/list/block.tsx (1)

262-262: LGTM! IssueStats placement improved.

The new placement of IssueStats after the issue name provides a more natural flow in the UI layout, improving the visual hierarchy and readability.

@sriramveeraghanta sriramveeraghanta merged commit e244f48 into preview Feb 6, 2025
18 of 22 checks passed
@sriramveeraghanta sriramveeraghanta deleted the chore-work-items-layout-improvement branch February 6, 2025 08:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants