---
url: /survive/6usk48bm/index.md
---
# 贡献指南

江理工生存手册是由一群致力于互帮互助的学生志愿者所组成的协作社区的作品，我们的社区成员包括了江理工的在读学生，往届学生和其他志愿者。江理工生存手册是一项立足于协作精神的事业，它的内容注重于**真实性**，**易用性**和**时效性**，其内容和产出不受任何单一的个人或机构的控制。我们随时欢迎任何江理工的学子或其他志愿人员参与我们的事业，并感谢这些[贡献者](../contributors.md)。

## 参与贡献

* 请将缺陷和需求在底部评论区指出，或通过邮件发送给我们。我们的邮箱地址是：

  1. `jsutxcpc_official@outlook.com`，这个是首选项；
  2. `jsut_survival_manual@proton.me`，前项目维护者的工作邮箱；
  3. `just-soso@outlook.com`

* 如果你希望为手册编写内容，可以参阅[高优先级项目](../../blog/公告/top.md)并通过以下方式：

  1. 直接页面底部编辑页面，这样可以直接在下面显示你的贡献。
  2. 直接将写好的文稿发送到邮箱。**请务必标明你希望放在目录中的位置**。
  3. 参阅 git 指南。

无论你采用哪一种方式参加贡献，你都同意你都贡献将以 [GNU GDL 协议](license.md) 发布。

内容选取及书写**建议参考**`SurviveSJTUManual`[上海交通大学生存手册](https://survivesjtu.gitbook.io/survivesjtumanual/)

## 格式指南

1. 请使用正确的，标准的，规范的中文书写。

2. 请注意 `等宽` 字体只使用于代码、命令等文本，不应该作为强调。强调请使用 **粗体**。滥用强调等于没有强调，并且会使得观感凌乱不堪，请掌握强调的使用量。

   * **错误**：**今天**是一个**好天气**，我和**父母**一起去**商场**买东西，我买了一个**很大的**变形金刚**玩具**，但是回到家一看，它是**坏的**！

   * **推荐**：今天是一个好天气，我和父母一起去商场买东西，我买了一个很大的变形金刚玩具，但是回到家一看，它是**坏的**！

3. 注意全角和半角标点符号，请不要混合使用。

4. 注意在英文单词和中文文本之间的空格，例如：

   * **错误**：这是一段Rust代码示例

   * **正确**：这是一段 Rust 代码示例

   * **错误**：一个鸡腿24元

   * **正确**：一个鸡腿 24 元

     另请参阅：

   * [Chinese Copywriting Guidelines](https://sparanoid.com/note/chinese-copywriting-guidelines/)

   * [W3C 中文排版需求](https://www.w3.org/TR/clreq/)

5. 请不要滥用表情符号。

## 内部指南

1. 不要随意删除文件。
2. 所有文档的内容都在仓库根目录的 `src` 目录内，所有的图片和文件资源都放入 `src/assets` 目录内。
3. 添加新文档后，务必修改 `SUMMARY.md` 以确保你都新文章正确输出。
4. 如果要添加新章节，请将新章节的目录命名为**英文**，再将文章命名为**中文**。
5. 每一个章节的 `README.md` 是该章节的综述。
6. 请**不要使用** `Typora` 等软件编写 Markdown 文稿，这些软件会替换图片标签为 HTML 标签导致不兼容。
7. 在添加图片和其他内容时，路径名称请使用 `UNIX` 的 `/` 而不是 `Windows` 的 `\`。
8. 本地修改后，请确保先使用 `mdbook server` 预览无误后再提交更改。
9. 请尽量使用现代的图像和视频格式，例如 `webp` 和 `webm` 格式。

## `git` 工作流参考

1. `git pull` 将远程主机分支拉取
2. 本地编辑
3. `git add`，`git comment` ，`git push origin master` 推送
4. 开启新的 `pr`

参考：<https://git-scm.com/book/zh/v2>

## Markdown 快速参考

参阅 [Markdown Syntax](https://www.markdown-cheatsheet.com)