## 贡献指南

如果你发现好工具、新公司、有价值的论文，或者发现链接失效，欢迎直接提交 [PR](https://github.com/Octoday-Hub/Embodied-AI/pulls) 或 [Issue](https://github.com/Octoday-Hub/Embodied-AI/issues)。你的每一次更新都在帮后来者少走弯路。

### 快速开始

#### 只想改一个链接？

1. 打开对应文件，点击右上角 `Edit this file`。
2. 修改后点击 `Propose changes`。
3. 按提示提交 [PR](https://github.com/Octoday-Hub/Embodied-AI/pulls) 即可，无需 Fork 到本地。

适用场景：

- 只改 1-2 处内容，例如修复失效链接、错别字、单条信息。
- GitHub 网页端会自动帮你创建临时分支，无需自己在本地命名分支。

#### 打算批量更新或新增内容？

1. Fork 本仓库到你的账号下。
2. 从 `main` 切出新分支。
3. 本地修改后提交 [PR](https://github.com/Octoday-Hub/Embodied-AI/pulls)。

适用场景：

- 批量更新多个条目。
- 新增整家公司 / 多篇论文 / 一组岗位。
- 需要按下方规则自定义分支名，方便维护者识别。

#### 分支命名

请按以下规则命名，方便维护者快速识别：

- `update-basics-[主题]` 对应 `00-basics.md`。
- `add-company-[公司名]` 对应 `01-companies.md`。
- `update-jobs-[公司名]` 对应 `02-jobs.md`。
- `update-paper-[论文名]` 对应 `03-papers.md`。
- `update-tools-[工具名]` 对应 `04-tools.md`。

如果你不确定该提 [PR](https://github.com/Octoday-Hub/Embodied-AI/pulls) 还是 [Issue](https://github.com/Octoday-Hub/Embodied-AI/issues)：

- **PR**：适合直接改内容、补链接、修错字。
- **Issue**：适合反馈问题、补充线索、先讨论再改。

### 内容规范

请遵循以下格式规范：

#### 认知基座 (00-basics.md)

- 推荐书籍需提供**书名**、**作者**、**出版年份**、**推荐理由**（可选）。
- 推荐课程需提供**课程名称**、**机构**、**链接**、**简介**。

书籍格式模板：

```text
- 书名：Modern Robotics
- 作者：Kevin M. Lynch, Frank C. Park
- 出版年份：2017
- 推荐理由：系统覆盖运动学、动力学与控制。
```

课程格式模板：

```text
- 课程名称：Robotics Specialization
- 机构：UPenn
- 简介：面向机器人入门的系统课程。
- 链接：https://example.com
```

#### 公司库 (01-companies.md)

- 提供**公司名称**、**官网链接**、**一句话简介**、**技术方向**、**地点**。
- 保持客观中立，一句话概括核心业务。

公司格式模板：

```text
- 公司名称：Example Robotics
- 一句话简介：专注于仓储搬运机器人与调度系统。
- 技术方向：`移动机器人` `仓储物流`
- 官网：https://example.com
```

#### 招聘信息 (02-jobs.md)

- 提供**岗位名称**、**公司**、**地点**、**类型**（全职/实习/校招）、**投递链接**。
- 招聘信息需标注**截止日期**或**更新时间**，发现过期信息请直接标注。 

招聘格式模板：

```text
- 公司：Example Robotics
- 岗位名称：机器人算法工程师
- 类型：社招
- 地点：上海
- 投递链接：https://example.com/jobs/123
- 更新时间：2026-05-21
```

#### 论文合集 (03-papers.md)

- 提供**论文标题**、**作者**、**发表会议/期刊**、**年份**、**代码链接**（如有）。
- 尽量附上**一句话总结**，说明核心贡献。
- 按研究方向分类（如 Manipulation，Locomotion，Navigation 等）。

论文格式模板：

```text
- 论文标题：Example Policy for Manipulation
- 作者：作者A，作者B
- 发表会议/期刊：arXiv
- 年份：2026
- 一句话总结：提出一种结合视觉与力觉的操作策略。
- 代码链接：https://github.com/example/repo
```

#### 工具矩阵 (04-tools.md)

- 提供**工具名称**、**类型**（仿真/控制/数据集等）、**官方链接**、**一句话简介**。
- 标注是否开源及主要编程语言。

工具格式模板：

```text
- 工具名称：ExampleSim
- 类型：仿真
- 官方链接：https://example.com
- 一句话简介：适合操作任务研究的轻量级仿真平台。
- 是否开源：是
- 主要编程语言：Python
```

### 信息准确性

- 可验证：提供的信息应能在官网或权威渠道核实。
- 时效性：招聘、投融资等信息请提供最新内容。
- 内容授权：提交 PR 即表示你同意将贡献内容以与本仓库相同的许可证发布。引用第三方内容请注明出处。

### 审核与合并

- 维护者会在 3 个工作日内 进行初审，如需修改会留言反馈。
- 通过审核后由维护者合并至 `main` 分支。
- 重大结构调整（如新增分类、修改目录）建议先开 Issue 讨论，避免 PR 被拒。

### 行为准则

- 保持友善与尊重。
- 尊重知识产权。
- 商业合作请通过邮件联系，避免在 Issue / PR 中发布广告。

### 致谢

感谢每一位贡献者 ！❤️ 

如有任何问题，欢迎联系：[octoday@yeah.net](mailto:octoday@yeah.net)。