新手贡献 Job Compass 指南
这篇教程适合谁
这篇教程写给完全没有 GitHub / git 经验的新手。如果你只是想给 Job Compass 分享一段面试经验（面经），跟着本文一步步做即可，不需要提前学习任何命令行或 git 知识。
Job Compass 是什么
Job Compass（找工指南）是 Atomeocean 团队发起的开源求职工具，帮助求职者更高效地探索美国职场。
只贡献到「面试经验」分类（重要）
请务必注意
给 Job Compass 贡献内容时，只需要考虑「面试经验分享」这一类内容，它由两个目录组成：docs/assets/json/interview-experience/ 下的 JSON 与 docs/zhHans/interview-experience/ 下的 Markdown。除这两个目录外，其它目录暂时不需要你操作。
这个分类按公司来组织，规则很简单：
- 每一家公司对应一个文件夹，文件夹名用公司英文小写、单词之间用短横线连接（例如
apple/、google/、bytedance/）。 - 每个公司文件夹里有一个
index.md，作为这家公司的入口页。 - 一篇面经是两个文件：一个存放面试基本信息的 JSON，一个存放面试过程的 Markdown。两个文件共用同一个六位随机 ID（由数字和小写字母组成，如
869pu4，自己随便想一个即可）作为文件名。
docs/assets/json/interview-experience/{company}/{六位随机ID}.json
docs/zhHans/interview-experience/{company}/{六位随机ID}.md以 Apple 为例，company 取 apple、六位随机 ID 取 869pu4：
docs/
├── assets/
│ └── json/
│ └── interview-experience/
│ └── apple/
│ └── 869pu4.json # 你新增的面试基本信息
└── zhHans/
└── interview-experience/
└── apple/
├── index.md # Apple 公司入口页（一般已经存在）
└── 869pu4.md # 你新增的面试过程如果你要贡献的公司文件夹还不存在，就新建一个；如果已经存在，直接在里面新增你的两个文件即可。
中英文同步
Job Compass 要求中文和英文目录结构保持一致。如果你有能力，欢迎在 docs/en/interview-experience/ 下按完全相同的路径补一份英文版；如果暂时只写中文，也没有关系。
两个文件里写什么
JSON 的字段规范、Markdown 的模板、以及引用来源的标注要求，统一以 面经内容规范 为准 —— 那一页有可以直接复制的模板，本页不再另给一份，以免两处写法不一致。
内容上只有三条红线：一次只提交一篇面经、不要直接提交 AI 生成的正文、不要照抄他人的答案。
怎么发起 PR（新手路径）
最简单的方式是全程在 GitHub 网页上操作，不需要在电脑上安装任何软件：
- 打开 job-compass 仓库，进入
docs/assets/json/interview-experience/目录。 - 点右上角
Add file→Create new file，在文件名输入框里填{company}/{六位随机ID}.json（如apple/869pu4.json）—— 输入/时 GitHub 会自动建好还不存在的公司文件夹。要改的是已有文件时，进入该文件点铅笔图标Edit this file。 - 编辑完成后点
Commit changes...，填写简短的提交说明，并新建一个分支来保存这次修改。 - 回到仓库首页，用左上方的分支选择器切到刚创建的那个分支，再进入
docs/zhHans/interview-experience/目录，用同样的方式新建 Markdown 文件（填apple/869pu4.md）。这一次提交时要选「提交到当前分支」，不要再新建分支 —— 两个文件必须在同一个分支上，才能放进同一个 PR。 - 打开仓库上方的
Pull requests选项卡，点New pull request创建 PR，填写标题和说明，就完成了。
每一步的详细图文说明，请直接参考 发布 Pull Request (PR) 教学，操作流程完全一致，只是把目标仓库换成 job-compass。
如果这是一次仪式性贡献（用于维持在职有效月份），请以 仪式性贡献流程指南 为准 —— 那一页有完整的图文步骤、验收规则，以及做不下去时由公司接手的方式。
如果你还不确定内容该放在 Job Compass 还是 Logbook，可以先看 根据内容选择仓库。