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

docs: update README.md #473

Merged
merged 2 commits into from
Jan 14, 2025
Merged

docs: update README.md #473

merged 2 commits into from
Jan 14, 2025

Conversation

YumoImer
Copy link
Collaborator

@YumoImer YumoImer commented Jan 14, 2025

Summary by CodeRabbit

  • 文档
    • 在 README 中添加了 Zhihu 和 Twitter 关注徽章
    • 为项目增加了更多社交媒体平台的推广渠道
    • 新徽章无缝集成到现有徽章集中

Copy link
Contributor

coderabbitai bot commented Jan 14, 2025

📝 Walkthrough

变更概述

演练

此拉取请求主要更新了两个README文件(英文和中文版本)的徽章。在README.md中添加了Twitter关注徽章,而在README-zh_CN.md中添加了知乎关注徽章。这些更改旨在增加项目在不同社交平台上的可见性,未对项目的核心功能进行任何修改。

变更

文件 变更摘要
README.md 添加Twitter关注徽章
README-zh_CN.md 添加知乎关注徽章

可能相关的PR

建议的审阅者

  • afc163

诗歌

🐰 徽章闪耀如星光,
社交平台齐欢唱,
推特知乎来助阵,
开源之路更明朗!
兔子为你喝彩🎉


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

github-actions bot commented Jan 14, 2025

Preview is ready

Copy link

Walkthrough

This pull request updates the README files by adding social media follow badges. Specifically, a Zhihu follow badge is added to the Chinese README, and a Twitter follow badge is added to the English README.

Changes

File Summary
README-zh_CN.md, README.md Added social media follow badges: Zhihu for Chinese README and Twitter for English README.
🪧 Tips For further assistance, please describe your question in the comments and @petercat-assistant to start a conversation with me.

@@ -8,7 +8,7 @@

[![CI status][github-action-image]][github-action-url] [![codecov][codecov-image]][codecov-url] [![NPM version][npm-image]][npm-url]

[![NPM downloads][download-image]][download-url] [![][bundlephobia-image]][bundlephobia-url] [![antd][antd-image]][antd-url]
[![NPM downloads][download-image]][download-url] [![][bundlephobia-image]][bundlephobia-url] [![antd][antd-image]][antd-url] [![Follow zhihu][zhihu-image]][zhihu-url]

Choose a reason for hiding this comment

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

Added a Zhihu follow badge to the README.

@@ -8,7 +8,7 @@ Craft AI-driven interfaces effortlessly.

[![CI status][github-action-image]][github-action-url] [![codecov][codecov-image]][codecov-url] [![NPM version][npm-image]][npm-url]

[![NPM downloads][download-image]][download-url] [![][bundlephobia-image]][bundlephobia-url] [![antd][antd-image]][antd-url]
[![NPM downloads][download-image]][download-url] [![][bundlephobia-image]][bundlephobia-url] [![antd][antd-image]][antd-url] [![Follow Twitter][twitter-image]][twitter-url]

Choose a reason for hiding this comment

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

Added a Twitter follow badge to the README.

Copy link

codecov bot commented Jan 14, 2025

Bundle Report

Bundle size has no change ✅

Copy link

cloudflare-workers-and-pages bot commented Jan 14, 2025

Deploying ant-design-x with  Cloudflare Pages  Cloudflare Pages

Latest commit: d95dd26
Status: ✅  Deploy successful!
Preview URL: https://25b9e20f.ant-design-x.pages.dev
Branch Preview URL: https://docs-update-readme.ant-design-x.pages.dev

View logs

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 (2)
README-zh_CN.md (1)

11-11: 建议为图片添加替代文本

为了提高可访问性,建议为所有徽章图片添加 alt 属性。

-[![NPM downloads][download-image]][download-url] [![][bundlephobia-image]][bundlephobia-url] [![antd][antd-image]][antd-url] [![Follow zhihu][zhihu-image]][zhihu-url]
+[![NPM 下载量][download-image]][download-url] [![包体积][bundlephobia-image]][bundlephobia-url] [![Ant Design][antd-image]][antd-url] [![在知乎上关注我们][zhihu-image]][zhihu-url]
🧰 Tools
🪛 Markdownlint (0.37.0)

11-11: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

README.md (1)

11-11: 建议为图片添加替代文本

为了提高可访问性,建议为所有徽章图片添加 alt 属性。

-[![NPM downloads][download-image]][download-url] [![][bundlephobia-image]][bundlephobia-url] [![antd][antd-image]][antd-url] [![Follow Twitter][twitter-image]][twitter-url]
+[![NPM Downloads][download-image]][download-url] [![Bundle Size][bundlephobia-image]][bundlephobia-url] [![Ant Design][antd-image]][antd-url] [![Follow us on Twitter][twitter-image]][twitter-url]
🧰 Tools
🪛 Markdownlint (0.37.0)

11-11: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2d75d58 and 61cf4fc.

📒 Files selected for processing (2)
  • README-zh_CN.md (2 hunks)
  • README.md (2 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
README-zh_CN.md

11-11: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

README.md

11-11: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: test / react component workflow
  • GitHub Check: build preview
  • GitHub Check: size
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: test / react component workflow
  • GitHub Check: Cloudflare Pages
🔇 Additional comments (2)
README-zh_CN.md (1)

11-11: 知乎关注徽章添加得当!

徽章样式与现有徽章保持一致,增强了项目在中文社区的可见度。

🧰 Tools
🪛 Markdownlint (0.37.0)

11-11: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

README.md (1)

11-11: Twitter关注徽章添加合适!

徽章样式与现有徽章保持一致,增强了项目在国际社区的可见度。

🧰 Tools
🪛 Markdownlint (0.37.0)

11-11: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

Copy link

github-actions bot commented Jan 14, 2025

size-limit report 📦

Path Size
dist/antdx.min.js 40.32 KB

Copy link

codecov bot commented Jan 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.45%. Comparing base (2d75d58) to head (d95dd26).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #473   +/-   ##
=======================================
  Coverage   91.45%   91.45%           
=======================================
  Files          67       67           
  Lines        1462     1462           
  Branches      384      384           
=======================================
  Hits         1337     1337           
  Misses        125      125           

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

@YumoImer YumoImer requested a review from a team January 14, 2025 03:38
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 (2)
README-zh_CN.md (2)

11-11: 徽章需要添加替代文本以提高可访问性

为了提高可访问性,建议为所有徽章图片添加描述性的替代文本。

-[![NPM downloads][download-image]][download-url] [![][bundlephobia-image]][bundlephobia-url] [![antd][antd-image]][antd-url] [![Follow zhihu][zhihu-image]][zhihu-url]
+[![NPM 下载量][download-image]][download-url] [![包大小][bundlephobia-image]][bundlephobia-url] [![Ant Design][antd-image]][antd-url] [![在知乎上关注我们][zhihu-image]][zhihu-url]
🧰 Tools
🪛 Markdownlint (0.37.0)

11-11: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


29-30: 建议统一徽章样式

为保持视觉一致性,建议将知乎徽章的样式与其他徽章保持一致。

-[zhihu-image]: https://img.shields.io/badge/-Ant%20Design-white?logo=zhihu
+[zhihu-image]: https://img.shields.io/badge/-Ant%20Design-blue?labelColor=black&logo=zhihu&style=flat-square
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 61cf4fc and d95dd26.

📒 Files selected for processing (1)
  • README-zh_CN.md (2 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
README-zh_CN.md

11-11: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: build preview
  • GitHub Check: test / react component workflow
  • GitHub Check: size
  • GitHub Check: test / react component workflow
  • GitHub Check: Cloudflare Pages

@YumoImer YumoImer changed the title docs: update Readme.md docs: update README.md Jan 14, 2025
@YumoImer YumoImer merged commit e4544ec into main Jan 14, 2025
15 checks passed
@YumoImer YumoImer deleted the docs/update-readme branch January 14, 2025 03:41
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