CONTRIBUTING.md 是什么？
告诉你怎么给项目做贡献的那个文件
你在看一个项目,里面躺着一个 CONTRIBUTING.md。它是一个 Markdown 文件,讲清怎么给这个项目做贡献:怎么搭建、怎么跑测试、分支和 PR 的约定、以及怎么报告问题。
GitHub、GitLab 会在对的时刻把它端出来——有人开新 issue 或 PR 时链到它,让贡献者在提交前先看到规则。这就是里面写什么、放在哪。
CONTRIBUTING.md 通常写什么
| 小节 | 讲什么 |
|---|---|
| 怎么搭起来 | 怎么克隆、装依赖、在本地把项目跑起来 |
| 跑测试 | 测试命令、以及提 PR 前哪些得过 |
| 分支 & PR 流程 | 分支命名、怎么开 PR、会被怎么 review |
| 提交规范 | commit message 格式、sign-off、或约定式提交 |
| 报告问题 | 在哪、怎么提一个 bug 或需求 |
| 行为准则 | 指向 CODE_OF_CONDUCT.md 的链接（如果项目有） |
不是每个文件都有全部这些,顺序也各不同。要点一致:给新贡献者提交一个"项目会接受的改动"所需的一切,让他不用再问。
CONTRIBUTING.md 放在哪
它放在仓库根目录,或 .github/ 文件夹里。GitHub 会在根目录、.github/、docs/ 里找它,一旦找到,就从"新建 issue"和"新建 PR"页面链过去。这就是为什么你常在正要开 PR 时,看到一句"请先读我们的贡献指南"。
它和仓库里其他 Markdown 文件的关系
一个项目通常有一小家子 Markdown 文件,各司其职:
| 文件 | 装什么 | 给谁看 |
|---|---|---|
README.md | 项目是什么、怎么用 | 所有人 |
CONTRIBUTING.md | 怎么贡献一个改动 | 想贡献的人 |
CODE_OF_CONDUCT.md | 社区行为规范 | 社区 |
AGENTS.md / CLAUDE.md | 给 AI 编程 agent 的规则 | AI 编程工具 |
给人看的总览文件,看 README.md 是什么？;写给 AI 编程工具的那些,看 我的 AI 工具读哪个规则文件 和 AGENTS.md、CLAUDE.md 是什么。
用 NoteLoom 读、改 CONTRIBUTING.md
CONTRIBUTING.md 就是纯 Markdown,和仓库里任何文件一样。NoteLoom 直接在浏览器里打开你的项目文件夹,把它在干净的 reading 视图里渲染出来,于是你能真的把指南读进去、而不是划一堆生文本;当你是给自己项目定规则的那个人时,在 source 视图里改。从零写一个,语法看 Markdown 怎么写。
先说清边界:NoteLoom 没有任何 AI,也不连接 GitHub 或任何 git 工具。它只打开、渲染、存回本地的 Markdown 文件;真正提交贡献,还在你平时的 git 流程里。
用起来:用 Chrome / Edge / Arc 打开 app.noteloom.cc,挂载项目文件夹,打开 CONTRIBUTING.md 读或改。直接存回本地,不上云、不用账号。
FAQ
CONTRIBUTING.md 文件是什么？
CONTRIBUTING.md 放在哪？
CONTRIBUTING.md 该写什么？
CONTRIBUTING.md 和 README.md 有什么区别？
CONTRIBUTING.md 是必须的吗？
手机或 Safari 能用 NoteLoom 读改 CONTRIBUTING.md 吗？
好好读一遍仓库的 CONTRIBUTING.md
用 Chrome / Edge / Arc 打开 NoteLoom,挂载项目文件夹,在干净视图里读或改它的 CONTRIBUTING.md。直接存回本地,不用装软件,也不用注册账号。