你有没有点开过别人的 GitHub 主页,发现上面有自我介绍、代表作品、技能标签,甚至还有代码统计卡片,再切回自己的主页——一片空白,只有仓库列表。

那个"特殊"的主页,靠的是一个叫 profile README 的机制。这篇讲讲它怎么弄,以及怎么写才不翻车。

原理:一分钟讲清

GitHub 有个隐藏规则:如果你建一个和用户名同名的仓库(比如用户名是 fusi,就建 fusi/fusi),这个仓库里的 README.md 会自动展示在你的个人主页顶部。

就这么简单。不需要插件,不需要配置,建对名字的仓库就行。

先想清楚:主页给谁看

动手写之前先想明白受众,因为这决定了你写什么:

  • 找工作 / 接单: 重点放代表作品和联系方式,HR 只看前三秒
  • 技术社交: 放你擅长的领域和正在折腾的东西,方便同好找到你
  • 纯自用: 怎么开心怎么写

大多数人是前两种的混合。核心原则:主页是你的技术名片,不是日记本。

必备元素和加分项

必备三件套:

  1. 一句话自我介绍:你是谁,干什么的
  2. 代表作品:3-5 个最拿得出手的项目,附一句话说明(别只丢链接,读 README 那篇 讲过,一句话介绍有多重要)
  3. 联系方式:邮箱或者博客地址,至少留一个

加分项(适量):

  • 技能标签:列几个真正熟练的,别把"Hello World 级别"的也写上
  • GitHub 统计卡片:那种自动生成的代码统计图,放一张点缀即可
  • 正在做的事:比如"最近在学 Rust",让人知道你的动态

写法技巧

克制。 我见过最糟糕的主页是堆了二十个徽章、五张统计卡片、三段动图,加载半天,什么都没记住。记住:主页是给人"扫一眼"的,不是"读一遍"的。

让项目自己说话。 与其写"我精通 X、Y、Z",不如直接链三个用 X、Y、Z 做的项目。作品比形容词有说服力。

保持更新。 主页上写着"2023 年的目标",现在是 2026 年——这种细节很减分。每季度花五分钟更新一次就行。

动手:三十分钟做出第一版

光讲道理不够,给一份可以直接照着做的清单:

  1. 新建和用户名同名的仓库,勾选"添加 README 文件"
  2. 开头写三行:你是谁、你干什么、你在哪能找到(博客/邮箱)
  3. 列 3 个代表作,每个一句话说明解决了什么问题
  4. 加 5-8 个技能标签,只写真正熟练的
  5. 放一张 GitHub 统计卡片,位置放在中部,别放开头抢戏
  6. 通读一遍,删掉所有自我吹捧的形容词

三十分钟,第一版就够用了。剩下的以后慢慢迭代——主页和代码一样,第一版能跑就行。

常见翻车现场

  • 徽章堆满屏,找不着重点
  • 放了一堆"计划学"的技能,实际一个都不会
  • 联系方式全是失效链接
  • 中英混杂、排版错乱,一看就是复制粘贴的模板没改完
  • 写了"大神"“全栈工程师"这种自我封号,极其劝退

写在最后

profile README 是个低成本高回报的东西,半小时就能搞定。但记住,美化是锦上添花——主页再好看,点进去仓库全是空的或者三年没更新,照样露馅。

先有拿得出手的东西,再谈展示。这和 《Git 基础》 里讲的道理一样:流程跑顺了,工具自然跟得上;项目做好了,主页随便写写都好看。