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

GitAuto: [Negative progress] <as proxy for conditional formatting - databars like excel> #67

Closed

Conversation

gitauto-ai[bot]
Copy link

@gitauto-ai gitauto-ai bot commented Nov 18, 2024

Resolves #64

What is the feature

Add support for negative numbers in the progress data bars, enabling visualization similar to Excel's conditional formatting data bars that handle both positive and negative values.

Why we need the feature

Currently, the progress bars effectively represent positive values, serving as a proxy for Excel-like data bars. However, in datasets that include negative values, the absence of support for negative numbers limits the functionality and visual accuracy. By supporting negative values, users can achieve a more comprehensive and accurate data visualization, mirroring the capabilities of Excel's conditional formatting and enhancing the tool's overall utility.

How to implement and why

  1. Identify Negative Values:

    • Modify app.py: Update the data processing logic to detect negative numbers within the dataset. This can be achieved by iterating through the data and flagging values that are below zero.
  2. Adjust Bar Rendering Logic:

    • Update Calculation: Adjust the calculation for bar lengths to account for the direction based on the sign of the value. Positive values will continue to fill the bar from left to right, while negative values will fill from right to left.
    • Modify Templates: In the templates directory, update the HTML/CSS templates to support directional changes. This may involve adding conditional classes or styles that reverse the fill direction for negative values.
  3. Visual Differentiation:

    • Color Coding: Implement distinct colors for positive and negative bars to enhance visual clarity. For example, positive bars could remain green, while negative bars switch to red.
    • CSS Updates: Update the CSS in the relevant style files to accommodate the new color schemes and directional fills.
  4. User Configuration:

    • Configurable Options: Allow users to customize colors and directions for positive and negative values via configuration settings in _config.yml. This adds flexibility and personalization to the feature.
  5. Testing and Validation:

    • Unit Tests: Write tests to ensure that negative values are correctly identified and rendered in the opposite direction without affecting positive values.
    • User Feedback: Conduct user testing to gather feedback on the new feature and make iterative improvements based on usability and visual effectiveness.
  6. Documentation:

    • Update README.md: Include instructions and examples on how to use the new feature, detailing any configuration options available to users.

Implementing these steps ensures that the progress bars can accurately represent both positive and negative values, enhancing the data visualization capabilities of the application and aligning it more closely with Excel's conditional formatting features.

About backward compatibility

This feature will be implemented in a backward-compatible manner. Existing functionality for positive values will remain unchanged, ensuring that current users are not affected by the updates. The addition of negative value support will be handled through optional configurations, allowing users to enable or disable the feature based on their needs without disrupting existing workflows.

Test these changes locally

git checkout -b gitauto/issue-64-59200f7d-94ad-4b4a-a816-5df27bcf9afe
git pull origin gitauto/issue-64-59200f7d-94ad-4b4a-a816-5df27bcf9afe

Copy link

vercel bot commented Nov 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
progressbar ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 18, 2024 0:12am

Copy link

coderabbitai bot commented Nov 18, 2024

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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

@gstraccini gstraccini bot added enhancement New feature or request gitauto GitAuto label to trigger the app in a issue. ⏳ waiting response Waiting on a response from another party labels Nov 18, 2024
@gstraccini gstraccini bot requested a review from guibranco November 18, 2024 00:14
@gstraccini gstraccini bot added 🚦 awaiting triage Items that are awaiting triage or categorization 🤖 bot Automated processes or integrations labels Nov 18, 2024
Copy link
Author

gitauto-ai bot commented Nov 18, 2024

Approve permission(s) to allow GitAuto to access the check run logs here: https://github.com/settings/installations/52064309/permissions/update

@guibranco guibranco closed this Nov 26, 2024
@guibranco guibranco deleted the gitauto/issue-64-59200f7d-94ad-4b4a-a816-5df27bcf9afe branch November 26, 2024 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🚦 awaiting triage Items that are awaiting triage or categorization 🤖 bot Automated processes or integrations enhancement New feature or request gitauto GitAuto label to trigger the app in a issue. ⏳ waiting response Waiting on a response from another party
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Negative progress] <as proxy for conditional formatting - databars like excel>
1 participant