Skip to content

docs(README): 修复英文md 中的描述错误,更新 QQ 群链接为可点击格式#654

Merged
zds-s merged 1 commit into
mineadmin:masterfrom
people-sea:docs/update-readme
Jul 18, 2025
Merged

docs(README): 修复英文md 中的描述错误,更新 QQ 群链接为可点击格式#654
zds-s merged 1 commit into
mineadmin:masterfrom
people-sea:docs/update-readme

Conversation

@people-sea

@people-sea people-sea commented Jul 17, 2025

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • 文档
    • 更新了 README,明确说明默认分支和 master-department 分支的功能区别,帮助用户选择合适的分支。
    • 将 QQ 群徽章添加了超链接,点击徽章可直接跳转至 QQ 群页面。

@coderabbitai

coderabbitai Bot commented Jul 17, 2025

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

本次更改主要针对两个 README 文件,更新了关于分支功能描述的表述,并将 QQ 群徽章添加了超链接,使其可点击跳转到 QQ 群页面,提升了文档的可用性和交互性。

Changes

文件/路径 变更摘要
README-en.md 修正了默认分支和 master-department 分支功能描述,明确部门、岗位与数据权限功能所在分支,并将 QQ 群徽章添加了超链接。
README.md 为 QQ 群徽章添加了超链接,点击后可跳转至 QQ 群页面,无其他内容修改。

Suggested labels

size:XS, lgtm

Poem

🐰
README 更新如春风,
徽章可点更贴心。
分支说明更清晰,
兔子跳跃乐无穷。
点击一跃进群聊,
文档世界更美妙!


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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this 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 or PR title 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.

@dosubot dosubot Bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Jul 17, 2025

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

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

31-33: 为 QQ 群徽章补充 alt 文本并添加安全属性

  1. img 标签缺少 alt 属性,违反 MD045 规则,也影响无障碍与 SEO。
  2. a 标签仅设置 target="_blank",建议同时加入 rel="noopener noreferrer",以避免潜在的窗口劫持与性能问题。
-<a href="https://qm.qq.com/q/PJnEgr4D8C" target="_blank">
-  <img src="https://svg.hamm.cn/badge.svg?key=QQ群&value=150105478" />
-</a>
+<a href="https://qm.qq.com/q/PJnEgr4D8C" target="_blank" rel="noopener noreferrer">
+  <img src="https://svg.hamm.cn/badge.svg?key=QQ群&value=150105478" alt="加入官方 QQ 群:150105478" />
+</a>
README-en.md (1)

31-33: 同样为徽章添加 alt 与安全属性

同上,缺少 altrel,建议统一修正。

-<a href="https://qm.qq.com/q/PJnEgr4D8C" target="_blank">
-  <img src="https://svg.hamm.cn/badge.svg?key=QQ Group&value=150105478" /> 
-</a>
+<a href="https://qm.qq.com/q/PJnEgr4D8C" target="_blank" rel="noopener noreferrer">
+  <img src="https://svg.hamm.cn/badge.svg?key=QQ Group&value=150105478" alt="Join official QQ Group: 150105478" /> 
+</a>
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7c5e930 and 88144fb.

📒 Files selected for processing (2)
  • README-en.md (1 hunks)
  • README.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README-en.md

32-32: Images should have alternate text (alt text)

(MD045, no-alt-text)

🔇 Additional comments (1)
README-en.md (1)

25-27: 部门岗位分支描述调整准确,措辞清晰

已正确指出默认分支不包含部门/岗位/数据权限功能,并指向 master-department 分支,信息准确清晰。

@zosfong

zosfong commented Jul 17, 2025

Copy link
Copy Markdown

大佬呐,QQ 群进群答案为啥一直都没对

@people-sea

Copy link
Copy Markdown
Member Author

大佬呐,QQ群进群为啥一直都没有对

进群问题回答不对吗

@zds-s
zds-s merged commit 4139090 into mineadmin:master Jul 18, 2025
20 checks passed
@dosubot dosubot Bot added the lgtm This PR has been approved by a maintainer label Jul 18, 2025
@coderabbitai coderabbitai Bot mentioned this pull request Nov 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants