Job Posting发布指南
本文用途
本文介绍如何按照流程添加一篇招聘信息文档，以便在Job Compass网站上展示相关职位信息。
🗺️ 一览流程
| 阶段 | 操作 | 产出 |
|---|---|---|
| 查重 | 搜索官网职位 - 检查仓库是否已有 | 确认是否需新增 |
| 建公司 | 创建公司文件夹 / index.md / data/ | 公司文件结构 |
| 建JSON | data/职位‑发布日期.json | 结构化招聘数据 |
| 建MD | 职位‑发布日期.md + 组件路径 | 招聘展示页面 |
| 提PR | 执行校验脚本 - Pull Request | 等待审核合并 |
1 查找招聘信息
在网上找到公司的官网招聘页面，获取完整的职位信息，包括公司名称、职位名称、工作地点、职位要求、薪资范围、福利待遇等信息。
2 检查Job Compass仓库是否已有该公司文件夹
在左边侧边栏的job postings 目录中，查看是否已存在该公司的文件夹。
- 如果不存在，进入第3步创建新公司文件夹。
- 如果已存在，跳到第4步检查该职位是否已存在。
3 创建新公司文件夹
若招聘信息中的公司名称未出现在 docs/zhHans/job-postings 目录下，请按以下步骤操作：
创建公司文件夹 在
docs/zhHans/job-postings目录下，新建一个文件夹，文件夹名称使用公司英文全称的小写形式- 要求：使用完整英文名称，不使用缩写、大写字母或中文。
- 示例：bloomberg, bank-of-america(正确)，BB、Bloomberg、美国银行 (错误)
创建
index.md文件 在新建的公司文件夹下，创建一个名为index.md的文件- 将该模版文件中的内容复制到该文件中
- 编辑该文件，将
title的值（模板中为 ）替换为正确的公司名称 (例如：Amazon 或 Cloudflare)。 - 在
index.md文件中的公司名称需要首字母大写，Bloomberg，Bank of America(正确)，apple(错误)
创建
data子文件夹 在公司文件夹下，创建一个名为data的子文件夹。
文件夹结构如下：
text
docs/
└─ zhHans/
└─ job-postings/
└─ 所在公司全称（全小写，无缩写）/
├─ index.md
└─ data/4 检查该职位是否已存在
进入公司名称文件夹，检查所找到的招聘信息是否已存在。
该公司的招聘数据存放在data文件夹中，每个JSON文件对应一个招聘信息。可以通过对比招聘链接来确认是否重复：
- 如果已存在相同职位，无需重复添加。
- 如果职位信息不存在，继续下一步。
5 创建职位Json文件
如果该职位信息尚未收录，则在该公司的data文件夹中创建一个新的Json文件。
- 文件命名规则：
- 文件名应与职位名称匹配
- 使用全小写字母
- 文件名称最后加上日期作为区分
- 使用连字符
-连接 - 例如：
software-engineer-20250102.json。 - 发现同日同岗重名则提示并追加递增序号 -1、-2，例如
software-engineer-20250102-1.json，software-engineer-20250102-2.json
示例: 在公司文件夹下新建
text
software-engineer-20250102.md6 填充招聘信息
将 模版文件的一键快速复制 中的内容复制到第5步中创建的文件中
若招聘信息页面未提供相关内容，可跳过对应字段
请确保信息准确，如职位已关闭，请及时更新或删除相关信息
7 创建职位Markdown文件
- 回到公司名称文件夹，创建一个与第5步同名的Markdown文件，文件名为
职位名称-日期.md（例如：software-engineer-20250102.md） - 将模版文件中的职位markdown文件模板部分 中的内容复制到该文件中
- 将片段中的
title值替换为文件名，并用空格替换连字符，例如：software engineer 20250102 - 将片段中的
{公司名称}替换为实际公司名称。- 示例：
{公司名称} 招聘信息替换为Amazon 招聘信息
- 示例：
- 找到第8行的JobPostingTable组件，将其中的
job-posting-json-path参数替换为实际JSON文件的路径- 模板中的路径格式为：
公司文件夹名/data/职位信息json文件名 - 将
公司文件夹名替换为实际的公司名 - 将
职位信息json文件名替换为第5步所创建的Json文件名 - 例如
meta/data/software-engineer-20110313.json，公司文件名需要小写
- 模板中的路径格式为：
小写路径
在job compass项目中和路径相关的变量均为全小写字母，用连字符-连接。
8 提交PR
完成招聘信息填充后，提交Pull Request（PR）到Job Compass项目。
- 提交自己的修改内容，并确保PR的描述清晰。
- 在job-compass-discussion Discord频道 中通知atomeocean开发团队，等待审核。
- 等待审核并进行必要的修改。