Skip to content

docs: 完善 README 项目展示与徽章 - #243

Merged
Palind-Rome merged 9 commits into
devfrom
docs/242-readme-showcase
Sep 20, 2026
Merged

Palind-Rome merged 9 commits into
devfrom
docs/242-readme-showcase

Conversation

@Palind-Rome

@Palind-Rome Palind-Rome commented Sep 20, 2026 •

Copy link
Copy Markdown
Owner

改动内容

  • 参考优秀开源项目的首屏组织方式,重构 README 顶部为居中 Logo、项目名、中文副标题和课程信息。
  • 增加 CI、代码质量、GitHub Stars、.NET 10、Vue 3、Oracle 18c+ 与 Docker Compose 徽章。
  • 使用 docs/images/logo.png 作为项目 Logo。
  • 增加首页截图和团队协作截图,展示在 README 对应位置。
  • README 其余正文保持原有内容和结构。

改动原因

项目已完成课程设计,需要完善仓库首页的首屏识别和实际成果展示,方便在 GitHub 上浏览项目。


关联 Issue

Closes #242

审查关注点

请重点检查首屏层级、徽章链接、图片相对路径以及 GitHub 页面中的图片渲染效果。

UI 改动

不涉及应用 UI;本次仅调整 README 首屏和文档展示图片。

改动前 改动后
README 使用普通一级标题和文字列表开头 增加 Logo、标题层级、课程信息、徽章和项目截图展示

测试说明

已运行 git diff --check,并确认 README 引用的 Logo、首页截图和团队协作截图均已加入仓库。本次不涉及后端、前端或数据库测试。


检查清单

代码质量

  • 后端代码已构建通过(dotnet build)
  • 前端代码已构建通过(pnpm build)
  • 已本地手工测试主要场景

本次仅修改文档和展示图片,上述代码质量检查项不适用。

数据库(仅涉及时勾选)

  • 无表结构变化
  • 表结构变更已写入 database/
  • 种子数据、视图、索引、触发器、存储过程已同步

文档与部署(仅涉及时勾选)

  • 课程文档已同步更新
  • 需要新增或修改 GitHub Secrets(请在 PR 描述中注明)
  • 需要修改服务器配置或手动迁移

Summary by CodeRabbit

  • 文档
    • 重新设计 README 顶部展示区域,新增项目 Logo、名称、副标题、技术栈徽章及首页截图。
    • 在“协作与环境”步骤后新增团队协作截图,提升项目说明的直观性。

 * 做了什么:在 README 顶部加入展示修缮占位注释,关联 Issue #242。
 * 为什么:为后续补充徽章、图像和项目展示内容建立领先提交。
 * 影响范围:仅影响 README.md,不改变项目代码、数据库或运行配置。
@Palind-Rome Palind-Rome added documentation Improvements or additions to documentation 优先级:P2 增强、统计或展示类任务 area:docs 文档、协作规范等非业务领域变更 labels Sep 20, 2026
@coderabbitai

coderabbitai Bot commented Sep 20, 2026 •

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: Palind-Rome/ClubHub/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 8b657e28-5aca-4b86-8e9c-0182c0c7a5a5

📥 Commits

Reviewing files that changed from the base of the PR and between 55503a3 and e7eed09.

⛔ Files ignored due to path filters (3)
  • docs/images/logo.png is excluded by !**/*.png
  • docs/images/团队协作.png is excluded by !**/*.png
  • docs/images/首页截图.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


Walkthrough

Changes

README 展示内容

Layer / File(s) Summary
README 页面展示更新
README.md
README 顶部新增 Logo、项目名称、副标题、六个技术徽章和首页截图。“协作与环境”步骤后新增团队协作截图。现有项目描述、技术栈、目录结构和课程要求保持不变。

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: wendaining

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed 标题“docs: 完善 README 项目展示与徽章”准确概括了 README 首屏、项目展示和徽章相关改动,符合简洁、明确的要求。
Description check ✅ Passed PR 描述完整说明了改动内容、改动原因、关联 Issue、审查关注点、UI 影响、测试方式和检查清单。描述与 README 文档改动一致,并明确说明代码、数据库和应用 UI 不受影响。
Linked Issues check ✅ Passed 针对 #242,PR 在 README 首屏增加 CI、GitHub Stars、.NET 10、Vue 3、Oracle 18c+ 和 Docker Compose 徽章,增加 Logo、首页截图和团队协作截图,并保留项目描述、技术栈、目录结构、运行说明和协作说明。摘要还确认本地图片已加入仓库,README 引用的 docker-compose.yml 存在,且已运行 `git diff -…
Out of Scope Changes check ✅ Passed PR 改动集中在 README 首屏、展示徽章和项目图片。图片属于 #242 要求的展示素材,徽章和排版属于项目展示改进。摘要未显示应用代码、数据库、业务 UI、运行说明或协作说明发生无关改动。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

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

Comment @coderabbitai help to get the list of available commands.

 * 做了什么:参考优秀开源项目的首屏结构,重排 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 存在。
@Palind-Rome
Palind-Rome marked this pull request as ready for review September 20, 2026 14:28
@Palind-Rome
Palind-Rome merged commit 1c9bedb into dev Sep 20, 2026
19 checks passed
@Palind-Rome
Palind-Rome deleted the docs/242-readme-showcase branch September 20, 2026 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs 文档、协作规范等非业务领域变更 documentation Improvements or additions to documentation 优先级:P2 增强、统计或展示类任务

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant