Repository navigation
chore(release): 发布 README 项目展示修缮 - #244
Merged
Merged
Conversation
* 做了什么：在 README 顶部加入展示修缮占位注释，关联 Issue #242。 * 为什么：为后续补充徽章、图像和项目展示内容建立领先提交。 * 影响范围：仅影响 README.md，不改变项目代码、数据库或运行配置。
* 做了什么：参考优秀开源项目的首屏结构，重排 ClubHub README 的标题、徽章、简介、能力总览和项目截图。 * 为什么：提升课程项目主页的可读性、完整性和展示效果。 * 影响范围：仅修改 README.md，保留现有技术、目录、运行与测试说明，并预留可替换的 Logo 位置。 * 验证方式：检查 Markdown diff 格式，并确认 README 引用的本地图片均存在。
* 做了什么：移除 README 中额外的快速导航、能力总览、截图展示和技术栈重排。 * 为什么：将本次 PR 范围限定为首屏结构与徽章。 * 影响范围：仅 README.md；保留 Logo 位置、项目标题、副标题、课程信息和徽章，恢复其余原有内容。 * 验证方式：已运行 `git diff --check`。
* 做了什么：在 README 首屏徽章区增加 GitHub Stars 动态徽章，并链接到仓库 Stargazers 页面。 * 为什么：补充项目受欢迎度的可见指标。 * 影响范围：仅新增 README 徽章；工作区已有的课程名称编辑未纳入本次提交。 * 验证方式：已运行 `git diff --check`。
* 做了什么：更新 README 首屏 Logo、课程信息和项目截图，并补充首页与团队协作展示图片。 * 为什么：完善项目主页的首屏视觉展示，便于在 GitHub 上查看课程项目成果。 * 影响范围：仅 README.md 与 docs/images/ 下的三张展示图片。 * 验证方式：已运行 `git diff --check`，并确认 README 图片引用对应本地文件。
* 做了什么：将可点击徽章的 `<img>` 与 `</a>` 收拢到同一行。 * 为什么：避免 GitHub 将锚点内的缩进空白渲染为徽章下方的蓝色短线。 * 影响范围：仅修改 README.md 的 CI、代码质量和 Stars 徽章排版。 * 验证方式：已运行 `git diff --check`。
* 做了什么：在 README 首屏徽章区增加 Docker Compose 徽章，并链接到 docker-compose.yml。 * 为什么：展示项目已有的容器化编排支持。 * 影响范围：仅修改 README.md。 * 验证方式：已运行 `git diff --check`，并确认 docker-compose.yml 存在。
docs: 完善 README 项目展示与徽章
Palind-Rome
requested review from
FEnjoyit,
SE-MAX-F,
YoumiaHina,
chiyuuu0123,
jyybacpg and
onnisama
as code owners
September 20, 2026 14:30
Palind-Rome
added
documentation
Contributor
|
Warning Review limit reachedNext included review available in 57 minutes. View limit detailsLimit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Review configuration: ⚙️ Run configurationConfiguration used: Repository: Palind-Rome/ClubHub/.coderabbit.yaml Review profile: CHILL Plan: Advanced Run ID: ⛔ Files ignored due to path filters (3)
📒 Files selected for processing (1)
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
改动内容
dev的 README 首屏展示修缮发布到main。dev → main差异仅涉及 README.md 和docs/images/下的三张展示图片。改动原因
ClubHub 课程项目已完成交付，需要将已在
dev验证通过的仓库首页展示修缮同步到阶段性稳定分支main。关联 Issue
Part of #242
审查关注点
main上的图片、徽章和相对路径是否正常渲染。UI 改动
不涉及应用 UI；仅更新 README 和展示图片。
main未包含 README 首屏展示修缮main同步dev中已完成的 README 首屏、徽章和图片展示测试说明
dev，其 CI、代码质量门禁和 CodeRabbit review 全部通过。dev → main差异仅包含README.md与三张图片。检查清单
代码质量
dotnet build）pnpm build）数据库（仅涉及时勾选）
database/文档与部署（仅涉及时勾选）