新手贡献 Job Compass 指南
这篇教程适合谁
这篇教程写给完全没有 GitHub / git 经验的新手。如果你只是想给 Job Compass 分享一段面试经验(面经),跟着本文一步步做即可,不需要提前学习任何命令行或 git 知识。
Job Compass 是什么
Job Compass(找工指南)是 Atomeocean 团队发起的开源求职工具,帮助求职者更高效地探索美国职场。
只贡献到「面试经验」分类(重要)
请务必注意
给 Job Compass 贡献内容时,只需要考虑把内容加到 docs/zhHans/interview-experience/ 这一个分类下(也就是「面试经验分享」)。其它目录暂时不需要你操作。
这个分类按公司来组织,规则很简单:
- 每一家公司对应一个文件夹,文件夹名用公司英文小写、单词之间用短横线连接(例如
apple/、google/、bytedance/)。 - 每个公司文件夹里有一个
index.md,作为这家公司的入口页。 - 每一篇面经都是文件夹里一个单独的
.md文件。
一个最小的示例路径:
docs/
└── zhHans/
└── interview-experience/
└── apple/
├── index.md # Apple 公司入口页(一般已经存在)
└── my-apple-sde.md # 你新增的一篇面经如果你要贡献的公司文件夹还不存在,就新建一个;如果已经存在,直接在里面新增你的面经 .md 文件即可。
中英文同步
Job Compass 要求中文和英文目录结构保持一致。如果你有能力,欢迎在 docs/en/interview-experience/ 下按完全相同的路径补一份英文版;如果暂时只写中文,也没有关系。
一篇面经长什么样
一篇面经就是一个 Markdown 文件,开头是一段 frontmatter(用 --- 包起来的元信息),下面是正文小节。大致骨架如下:
---
title: SDE
description: 一句话概括这段面经
createdDate: 2026-07-01
lastUpdated: 2026-07-01
---
# Apple SDE 面试经验
## 1. 基本信息
- 公司信息:[Apple](https://www.apple.com/careers/)
- 面试时间:2025年Q4
## 面试过程
(每一轮问了什么、怎么答的)
## 面试结果反馈
(是否通过、个人总结)不用担心格式不完美,参考现有的面经文件照着写就好,例如仓库里 interview-experience/apple/ 下已有的文章。
怎么发起 PR(新手路径)
最简单的方式是全程在 GitHub 网页上操作,不需要在电脑上安装任何软件:
- 打开 job-compass 仓库,进入
docs/zhHans/interview-experience/下对应公司的文件夹。 - 点右上角
Add file→Create new file新建你的面经文件(或对已有文件点铅笔图标Edit this file修改)。 - 编辑完成后点
Commit changes...,填写简短的提交说明,并新建一个分支来保存这次修改。 - 在跳转出来的页面点
Create pull request,填写标题和说明,就完成了。
每一步的详细图文说明,请直接参考 发布 Pull Request (PR) 教学,操作流程完全一致,只是把目标仓库换成 job-compass、目标目录锁定在 interview-experience/。
如果你还不确定内容该放在 Job Compass 还是 Logbook,可以先看 根据内容选择仓库。