+
Skip to content

Update README.md badges #2379

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Mar 27, 2025
Merged

Update README.md badges #2379

merged 1 commit into from
Mar 27, 2025

Conversation

arkid15r
Copy link
Collaborator

@arkid15r arkid15r commented Mar 27, 2025 •
edited
Loading

Proposed change

Resolves #2378

Update badges look:

Screenshot 2025-03-26 at 7 45 05 PM Screenshot 2025-03-26 at 7 46 13 PM

Type of change

  • New country/market holidays support (thank you!)
  • Supported country/market holidays update (calendar discrepancy fix, localization)
  • Existing code/documentation/test/process quality improvement (best practice, cleanup, refactoring, optimization)
  • Dependency update (version deprecation/pin/upgrade)
  • Bugfix (non-breaking change which fixes an issue)
  • Breaking change (a code change causing existing functionality to break)
  • New feature (new holidays functionality in general)

Checklist

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 27, 2025 •
edited
Loading

Summary by CodeRabbit

  • Documentation
    • Enhanced the presentation of key project badges by consolidating them into a single, compact line with improved spacing.
    • Applied layout updates to provide a cleaner, more visually consistent documentation view.

Walkthrough

The pull request updates the README.md file by consolidating the HTML anchor and image tags used for badge links into a single line with non-breaking spaces ( ) for spacing. It eliminates the previous multi-line formatting and indentation while maintaining the original table structure. Additionally, a markdown linting disable comment (MD033) has been added at the beginning of the table. No changes were made to declared public entities.

Changes

File Change Summary
README.md Consolidated badge links into a single line using   for spacing, removed extra line breaks/indentation, and added an MD033 disable comment.

Assessment against linked issues

Objective Addressed Explanation
Improve README.md GitHub badges look (#2378) ✅
📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 71976d2 and 6e2d397.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🔇 Additional comments (6)
README.md (6)

7-7: Markdown Linting Directive Added
The addition of the <!-- markdownlint-disable MD033 --> comment helps avoid unnecessary linting warnings for the table layout. This is a clear and purposeful improvement for readability.

12-12: Consolidated PyPI Badge Links
The PyPI badge links have been combined into one concise line using &nbsp; for spacing. This streamlines the presentation and improves consistency in the table.

18-18: Streamlined CI/CD Badge Row
The CI/CD badge links are now consolidated into a single line, enhancing clarity and reducing visual clutter in the table.

24-24: Refined Code Badge Row Display
The Code badge row now presents all badge links in one line with proper non-breaking spaces. This simplifies the layout while keeping the information accessible.

30-30: Unified GitHub Badge Row Format
The GitHub badge row has been updated to follow the same consolidated format as the others. This consistent approach makes the badge section more uniform and maintainable.

36-36: Optimized Citation Badge Presentation
The Citation badge now appears on a single line, ensuring that the overall badge presentation remains consistent throughout the table.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

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.

@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@codecov Codecov
Copy link

codecov bot commented Mar 27, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (71976d2) to head (6e2d397).
Report is 2 commits behind head on dev.

Additional details and impacted files 
@@            Coverage Diff            @@
##               dev     #2379   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          204       204           
  Lines        12853     12853           
  Branches      1817      1817           
=========================================
  Hits         12853     12853

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

PPsyrius
PPsyrius approved these changes Mar 27, 2025
View reviewed changes
Copy link
Collaborator

@PPsyrius PPsyrius left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🎨

@PPsyrius PPsyrius added this pull request to the merge queue Mar 27, 2025
Merged via the queue into vacanza:dev with commit 1eee2bc Mar 27, 2025
33 checks passed
@arkid15r arkid15r deleted the update-readme branch March 27, 2025 03:23
@arkid15r arkid15r mentioned this pull request Apr 7, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@PPsyrius PPsyrius PPsyrius approved these changes

@KJhellico KJhellico Awaiting requested review from KJhellico KJhellico is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve README.md GitHub badges look
2 participants
@arkid15r @PPsyrius
点击 这是indexloc提供的php浏览器服务，不要输入任何密码和下载