docs: add Star History section to README #1177
Conversation
Added a section for Star History, like in github.com/ant-design/pro-components Hope you like it 🚀 Signed-off-by: Luca Barbato <[email protected]>
📝 WalkthroughWalkthrough在 README.md 的“Need Help?”部分后新增“Star History”小节，插入一个指向 ant-design/x 星标历史页面的徽章链接。仅文档变更，不涉及代码或公开接口调整。 Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 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. Comment |
|
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @lucabubi, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces a new "Star History" section to the project's README.md file. This enhancement aims to provide a clear and engaging visual representation of the project's growth in terms of GitHub stars, making it easier for visitors to quickly gauge its popularity and development trajectory.
Highlights
- Documentation Enhancement: A new "Star History" section has been added to the
README.mdfile to visually track the project's GitHub star growth. - Visual Project Growth: This addition provides a dynamic chart showing the project's star history, similar to other Ant Design projects, offering a quick overview of its popularity and engagement.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
|
Warning Gemini encountered an error creating the review. You can try again by commenting |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
README.md (3)
292-295: 改用官方 Star History 嵌入与目标地址，避免依赖个人域名当前图片来源于第三方个人域名
api.lucabubi.me，点击后跳转到个人仓库而非本仓库的星标历史页面。建议使用 star-history 官方 SVG 接口与页面，可靠性和可维护性更高，链接也更直达。可直接替换为如下更稳妥的实现：
-[](https://github.com/lucabubi/star-history) +[](https://star-history.com/#ant-design/x)请确认目标页面渲染正常且未被速率限制；如需我验证外链可用性与加载速度，请告知。
292-292: 与全局标题风格保持一致（加上表情符号）README 其他章节标题普遍使用表情符号（如 “✨ Features”、“📦 Installation”）。为一致性，建议将本节标题调整为：
-## Star History +## ⭐ Star History
294-294: 改进无障碍描述文本（alt）进一步提升可读性，建议在图片 alt 中明确仓库名：
-[](https://star-history.com/#ant-design/x) +[](https://star-history.com/#ant-design/x)
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1177 +/- ##
=======================================
Coverage 92.52% 92.52%
=======================================
Files 69 69
Lines 1591 1591
Branches 413 413
=======================================
Hits 1472 1472
Misses 119 119 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
1 participant
中文版模板 / Chinese template
🤔 This is a ...
🔗 Related Issues
💡 Background and Solution
Added a section for Star History, like in github.com/ant-design/pro-components
Hope you like it 🚀
📝 Change Log
Summary by CodeRabbit