Beginner's Guide to Contributing to Job Compass

Published 2026-07-01

Updated at 2026-07-01

Views —

Who This Guide Is For

This guide is written for complete beginners with no GitHub / git experience. If you just want to share an interview experience with Job Compass, follow the steps below — you don't need to learn any command line or git knowledge in advance.

What Is Job Compass

Job Compass is an open-source job-hunting tool started by the Atomeocean team to help job seekers explore the U.S. job market more efficiently.

• Website: http://jobcompass.atomeocean.com/
• GitHub repository: https://github.com/atomeocean/job-compass

Only Contribute to the "Interview Experience" Category (Important)

Please note

When contributing to Job Compass, you only need to add content under the docs/zhHans/interview-experience/ category (i.e. "Interview Experience"). You don't need to touch any other directory for now.

This category is organized by company, and the rules are simple:

• Each company maps to one folder, named with the company's English name in lowercase, words joined by hyphens (e.g. apple/, google/, bytedance/).
• Each company folder contains an index.md as the company's landing page.
• Each interview experience is a separate .md file inside the folder.

A minimal example path:

docs/
└── zhHans/
    └── interview-experience/
        └── apple/
            ├── index.md          # Apple landing page (usually already exists)
            └── my-apple-sde.md   # the interview experience you add

If the company folder you want to contribute to doesn't exist yet, create one; if it already exists, just add your interview experience .md file inside it.

Keep Chinese and English in sync

Job Compass requires the Chinese and English directory structures to stay identical. If you're able to, you're welcome to add an English version under docs/en/interview-experience/ at the exact same path; if you only write Chinese for now, that's fine too.

What an Interview Experience Looks Like

An interview experience is a Markdown file that starts with a block of frontmatter (metadata wrapped in ---), followed by the body sections. The rough skeleton looks like this:

---
title: SDE
description: A one-line summary of this interview experience
createdDate: 2026-07-01
lastUpdated: 2026-07-01
---
# Apple SDE Interview Experience

## 1. Basic Info
- Company: [Apple](https://www.apple.com/careers/)
- Interview date: Q4 2025

## Interview Process
(what each round asked, and how you answered)

## Result & Feedback
(whether you passed, and your own takeaways)

Don't worry about getting the formatting perfect — just follow an existing interview-experience file, for example the articles already under interview-experience/apple/ in the repository.

How to Open a PR (Beginner Path)

The easiest way is to do everything on the GitHub website — no software to install on your computer:

1. Open the job-compass repository and go to the folder for your company under docs/zhHans/interview-experience/.
2. Click Add file → Create new file in the top right to create your interview experience file (or click the pencil icon Edit this file on an existing file to edit it).
3. When you're done editing, click Commit changes..., write a short commit message, and create a new branch to save your changes.
4. On the page that appears, click Create pull request, fill in a title and description, and you're done.

That's the whole flow: edit or add a file, commit it to a new branch, and open a pull request. Just keep your target directory locked to interview-experience/.