Skip to content

docs: 新增 fork banner 揭露 upstream PR 貢獻#2047

Closed
ericcai0814 wants to merge 1 commit into
affaan-m:mainfrom
ericcai0814:docs/add-fork-banner
Closed

docs: 新增 fork banner 揭露 upstream PR 貢獻#2047
ericcai0814 wants to merge 1 commit into
affaan-m:mainfrom
ericcai0814:docs/add-fork-banner

Conversation

@ericcai0814
Copy link
Copy Markdown
Contributor

@ericcai0814 ericcai0814 commented May 24, 2026 •
edited by coderabbitai Bot
Loading

Summary

動機

Eric 求職 portfolio 揭露策略：

  • fork 在 ericcai0814 本身 0 commit，若 reviewer 點進來不知道為何釘
  • 兩個 merged PR 是 portfolio 內最強的「外部代碼審查通過」signal
  • 第一眼可見原則：banner 放最頂部不被 badges / language switcher 蓋過

變更

README.md: 新增 9 行（fork banner blockquote + --- 分隔線）

Test plan

Summary by cubic

Add a fork banner at the top of README.md to highlight and link to my merged upstream contributions in affaan-m/ECC (PR #161, #171). The banner appears before the Language line, is separated by ---, explains the spec-driven work, and leaves the rest of the upstream README unchanged.

Written for commit 1cf9b02. Summary will update on new commits. Review in cubic

Summary by CodeRabbit

  • Documentation
    • Updated README with a new "About this fork" section documenting upstream contributions and clarifying the fork's relationship to the original project.

Review Change Stack

@EricCaiCai
docs: 新增 fork banner 揭露 upstream PR 貢獻
1cf9b02 
在 README 最頂部插入 fork banner，明確標示：
- 本 fork 的主要貢獻在 upstream affaan-m/ECC 的 PR affaan-m#161 + affaan-m#171（已 merged）
- 貢獻為 spec-driven 產出（specs by me, implementation via Claude Code, reviewed and submitted by me）
- 上游 maintainer merge = 最強的 external code review signal
- 保留原 upstream README 不動

目的：讓 GitHub profile 點進 fork 的 reviewer 第一眼看到 PR signal，避免誤判為「0 commit fork」。
@ericcai0814 ericcai0814 requested a review from affaan-m as a code owner May 24, 2026 05:59
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 24, 2026 •
edited
Loading

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ee6d3471-0a4e-4ad8-a302-ca15405faef7

📥 Commits

Reviewing files that changed from the base of the PR and between 1e8c7e7 and 1cf9b02.

📒 Files selected for processing (1)
  • README.md
📝 Walkthrough

Walkthrough

The README.md file now opens with a new "About this fork" section that credits the fork author's upstream contributions and clarifies that the remainder of the documentation originates from the upstream maintainer, preserving the existing content below.

Changes

Fork attribution and documentation

Layer / File(s) Summary
Fork attribution and upstream reference
README.md		 New "About this fork" section at the top documents the fork author's upstream merged PRs and clarifies that the remaining README content is from the upstream maintainer.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A fork that credits where it's due,
With upstream PRs shining through,
The original docs stand proud and tall,
Attribution honors one and all! 🐰📚

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
⚔️ Resolve merge conflicts
  • Resolve merge conflict in branch docs/add-fork-banner

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 and usage tips.

@ericcai0814
Copy link
Copy Markdown
Contributor Author

ericcai0814 commented May 24, 2026

Apologies — this PR was created accidentally due to a fork+gh-pr-create default routing. The change is intended for my own fork's README only (to add a banner explaining the upstream PRs I contributed). Closing now and re-opening on the fork. Sorry for the noise.

@ericcai0814 ericcai0814 mentioned this pull request May 24, 2026
Merged
4 tasks
@ericcai0814 ericcai0814 deleted the docs/add-fork-banner branch May 26, 2026 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@affaan-m affaan-m Awaiting requested review from affaan-m affaan-m is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ericcai0814 @EricCaiCai