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

feat: adding new forth color (blue) option #26

Merged
merged 1 commit into from
Jun 1, 2024

Conversation

claranceliberi
Copy link
Contributor

@claranceliberi claranceliberi commented Jun 1, 2024

I guess we needed new color, I met a situation where I needed new color option

Let us say
red: failed deployment
yellow: deploying
green: deployed
blue: undeployed (new color)

I bilieve the third color would be able to fit other scenarios which must not necessary be in error,warning,sucess color scheme

Summary by CodeRabbit

  • New Features

    • Introduced blue badge formatting in markdown text.
  • Tests

    • Added a test case to ensure the correct functionality of the blue badge formatting.

I guess we needed new color, I met a situation where I needed new color option

Let us say
red: failed deployment
yellow: deploying
green: deployed
blue: undeployed (new color)

I bilieve the third color would be able to fit  other scenarios  which must not necessary  be in error,warning,sucess color scheme
Copy link

coderabbitai bot commented Jun 1, 2024

Walkthrough

The recent updates introduce two new functions, blueBadge and BlueBadgef, to the Markdown struct in badge.go, allowing for the addition of blue badge formatting to text. Additionally, a test case for BlueBadgef has been added to badge_test.go to verify its functionality.

Changes

File Change Summary
badge.go Added blueBadge and BlueBadgef functions to Markdown struct.
badge_test.go Added a test case for the BlueBadgef function.

Poem

In code's vast realm, a badge of blue,
Now marks the text in a vibrant hue.
Functions crafted with care and might,
Ensuring markdown shines so bright.
Tests now guard this badge so true,
A coder's dream, a vision anew.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a3790e4 and 6af8c5d.

Files selected for processing (2)
  • badge.go (1 hunks)
  • badge_test.go (1 hunks)
Files skipped from review due to trivial changes (1)
  • badge_test.go
Additional context used
golangci-lint
badge.go

6-6: undefined: Markdown


12-12: undefined: Markdown


17-17: undefined: Markdown

Additional comments not posted (2)
badge.go (2)

38-42: Consider making blueBadge public if it should be consistent with other badge functions like RedBadge, YellowBadge, and GreenBadge.


44-47: LGTM! The function correctly implements the formatted badge functionality for blue color.

@nao1215
Copy link
Owner

nao1215 commented Jun 1, 2024

@claranceliberi
Thank you for the pull request.
Your explanation was clear, so I immediately understood the use case.

@nao1215 nao1215 merged commit 1404909 into nao1215:main Jun 1, 2024
17 checks passed
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.

2 participants