CONTRIBUTING.md:给潜在贡献者的"入伙指南"
上一篇写了 CHANGELOG.md,这次轮到仓库根目录里另一位常驻成员:CONTRIBUTING.md。 如果你观察过那些"活得很好"的开源项目——Ruby on Rails、Kubernetes、VS Code——会发现它们都有一份 CONTRIBUTING.md。它回答一个问题:一个素不相识的陌生人,要怎么才能帮你写代码? ...
上一篇写了 CHANGELOG.md,这次轮到仓库根目录里另一位常驻成员:CONTRIBUTING.md。 如果你观察过那些"活得很好"的开源项目——Ruby on Rails、Kubernetes、VS Code——会发现它们都有一份 CONTRIBUTING.md。它回答一个问题:一个素不相识的陌生人,要怎么才能帮你写代码? ...
打开任何一个有点年头的开源仓库,根目录里通常躺着这么几位:README.md 负责"这是什么、怎么用",LICENSE 负责"允不允许你用",CONTRIBUTING.md 负责"欢迎来贡献",AGENTS.md 负责"告诉 AI 代理怎么干活"……而 CHANGELOG.md 负责最后一件事:这个项目从出生到现在,每一次重要的变化。 ...
打开任何一个 GitHub 仓库,大约在右侧栏「About」下方,都会看到一行小字:License: MIT、License: Apache-2.0、License: GPL-3.0……有的仓库干脆什么都不显示。这行小字看起来不起眼,却决定了别人能不能用你的代码、能不能改、能不能闭源卖钱,甚至决定了你自己将来能不能反过来告抄袭。 ...
你可能已经注意到了,本仓库的根目录里躺着一个 CLAUDE.md——就是 Claude Code(Anthropic 的 AI 编码代理)在这个项目里工作时读的"操作手册"。它告诉代理:这是一个 Hugo 博客、文章命名有什么规矩、frontmatter 怎么写、有哪些自定义布局。 ...