Skip to content

[WEB 3132] chore: progress helper function and code refactor#6419

Merged
pushya22 merged 1 commit intopreviewfrom
chore-progress-helper-and-code-refactor
Jan 17, 2025
Merged

[WEB 3132] chore: progress helper function and code refactor#6419
pushya22 merged 1 commit intopreviewfrom
chore-progress-helper-and-code-refactor

Conversation

@anmolsinghbhatia
Copy link
Collaborator

@anmolsinghbhatia anmolsinghbhatia commented Jan 17, 2025

Description

This PR includes following changes:

  • Progress helper function added.
  • Code refactor

Type of Change

  • Code refactoring

References

[WEB 3132]

Summary by CodeRabbit

  • New Features

    • Introduced IssueStats component for displaying issue statistics
    • Added getProgress utility function to calculate progress percentage
  • Improvements

    • Enhanced IssueBlock component to conditionally render issue statistics for epic issues

@makeplane
Copy link

makeplane bot commented Jan 17, 2025

Pull Request Linked with Plane Issues

Comment Automatically Generated by Plane

2 similar comments
@makeplane
Copy link

makeplane bot commented Jan 17, 2025

Pull Request Linked with Plane Issues

Comment Automatically Generated by Plane

@makeplane
Copy link

makeplane bot commented Jan 17, 2025

Pull Request Linked with Plane Issues

Comment Automatically Generated by Plane

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 17, 2025

Walkthrough

This pull request introduces a new IssueStats React component and a utility function for calculating progress. The IssueStats component is created in the issues layout components and is conditionally rendered within the IssueBlock component for epic issues. A new getProgress helper function is added to calculate percentage progress based on completed and total values, providing a utility for progress-related calculations.

Changes

File Change Summary
web/ce/components/issues/issue-layouts/issue-stats.tsx Added new React functional component IssueStats with issueId prop
web/core/components/issues/issue-layouts/list/block.tsx Imported IssueStats and conditionally rendered with issueId prop
web/helpers/common.helper.ts Added getProgress utility function to calculate percentage progress

Possibly related PRs

Suggested labels

🧹chore, 🛠️refactor

Suggested reviewers

  • sriramveeraghanta
  • rahulramesha
  • gurusainath

Poem

🐰 A rabbit's tale of stats so bright,
Tracking progress with pure delight,
Epic issues now have their say,
With metrics hopping into play,
Code hops forward, clean and light! 📊

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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.

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: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 00cc338 and 58ff684.

📒 Files selected for processing (3)
  • web/ce/components/issues/issue-layouts/issue-stats.tsx (1 hunks)
  • web/core/components/issues/issue-layouts/list/block.tsx (2 hunks)
  • web/helpers/common.helper.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Analyze (javascript)
  • GitHub Check: Analyze (python)
🔇 Additional comments (2)
web/ce/components/issues/issue-layouts/issue-stats.tsx (1)

1-2: Verify if client-side directive is necessary.

The component currently doesn't use any client-side features. Consider removing the "use client" directive unless you plan to add client-side functionality.

web/core/components/issues/issue-layouts/list/block.tsx (1)

25-25: LGTM! Clean integration of IssueStats component.

The changes properly integrate the IssueStats component for epic issues:

  • Import is well-organized with other component imports
  • Component is conditionally rendered only for epic issues
  • Required props are correctly passed

Also applies to: 280-280

@pushya22 pushya22 merged commit 9ae1ce0 into preview Jan 17, 2025
12 of 14 checks passed
@pushya22 pushya22 deleted the chore-progress-helper-and-code-refactor branch January 17, 2025 10:11
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