跳转至

如何参与共建

不会 GitHub、不会编程，也可以为这份指南补充内容。最简单的方法是直接在网页上修改：你提交的是一份修改申请，不会立刻改动正式网站，因此可以放心尝试。

只想改一个错别字也完全可以

纠正错别字、更新失效链接、补充一条经验，都是有价值的贡献。第一次不必追求写出一篇完整文章。

快速了解整个流程

  1. 登录或注册 GitHub。

  2. 打开指南中想要修改的页面。

  3. 点击页面右上角的编辑按钮。

  4. 修改文字，并检查预览效果。

  5. 提交修改说明。

  6. 创建 Pull Request，等待维护者审核。

Pull Request 是什么：

Pull Request 常被简称为 PR，可以把它理解为一份“修改申请”。

你提交 PR 后，修改会先单独保存。维护者可以查看你改了哪些内容、提出问题或建议；确认无误并合并后，修改才会进入正式网站。提交 PR 不等于直接发布，所以不用担心一次操作就把网站弄坏。

如果你没有这个仓库的写入权限，在网页上编辑文件时，GitHub 通常会自动为你创建一份副本（Fork），再引导你提交 PR。你不需要提前学习 Git 命令。

开始之前

你需要准备：

  • 一个 GitHub 账号；
  • 想要修改或补充的内容；

涉及保研政策、培养方案、竞赛规则、课程安排等可能变化的信息时，请尽量写明适用年份并附上来源。

不要上传个人隐私、未经许可的聊天记录以及其他可能引起争议的内容。

第一步：找到要修改的页面

在本站打开目标页面，点击正文右上角的编辑图标。随后会跳转到 GitHub，并打开这个页面对应的 Markdown 文件。

如果没有看到编辑按钮，也可以进入本站的 GitHub 仓库，在 docs 文件夹中找到相应的 .md 文件，再点击铅笔形状的编辑按钮。

为什么看到的是 Markdown 文件？

本站的大部分正文都保存在 .md 文件中。Markdown 是一种简单的排版语法，不需要编写网页代码。

第二步：修改并预览内容

在编辑框中直接修改文字即可。编辑 Markdown 文件时，可以使用 GitHub 提供的预览功能检查标题、列表、链接等基本格式。

修改时建议遵循以下原则：

  • 尽量只改与本次贡献有关的内容；
  • 不要删除自己不确定的原有信息；
  • 保持原页面的语言风格和标题层级；
  • 大段新增内容时，注意在段落之间留一个空行；
  • 不确定的地方可以在 PR 说明中向维护者提问。

GitHub 的预览效果与本站最终效果可能略有不同，尤其是数学公式和提示框。只要语法符合下文说明，维护者会在合并前检查最终页面。

第三步：提交修改

编辑完成后，点击页面上的 Commit changes（提交更改）按钮。GitHub 的界面可能会随版本变化，但通常需要填写：

  • 简短标题：一句话概括改了什么；
  • 补充说明：解释修改原因、信息来源或仍需确认的问题。

好的标题应当具体，例如：

更新 2026 年化学学院保研政策链接
补充大二下学期学习建议
修正元素所位置描述中的错误

不建议只写“修改”“更新”或“fix”，因为维护者很难快速判断内容。

如果 GitHub 提示创建新分支或 Fork，按照页面默认选项继续即可。它们的作用都是把你的修改与正式网站暂时分开。

第四步：创建 Pull Request

提交更改后，GitHub 通常会进入创建 Pull Request 的页面。请再次确认标题，并在说明中写清楚：

## 修改了什么

补充或修正的主要内容。

## 为什么修改

修改原因，以及相关信息来源。

## 其他说明

仍然不确定、希望维护者帮助检查的地方。

确认后点击 Create pull request。看到新的 PR 页面，就说明修改申请已经提交成功。

提交之后会发生什么

维护者会查看 PR 中的文件变化，并可能：

  • 直接同意并合并；
  • 留言询问信息来源；
  • 建议调整表述或格式；
  • 帮助处理图片、路径或复杂排版问题。

如果收到修改建议，直接在 PR 中回复即可。维护者合并 PR 后，网站还需要经过自动构建和发布，因此页面不会在点击提交后立即变化。

Markdown 快速入门

下面这些语法已经足够完成大多数内容贡献。需要更完整的说明时，可以查看 GitHub 的 Markdown 官方教程。

标题

在文字前加入 # 和一个空格：

# 页面标题
## 一级小节
### 二级小节

每个页面通常只使用一个 # 作为页面标题，正文从 ## 开始。不要为了让文字变大而随意跳过标题层级。

段落和换行

两个段落之间要留一个空行：

这是第一段。

这是第二段。

不要依靠连续输入空格来缩进或对齐文字，不同设备上的显示效果可能不同。

加粗和斜体

这是**需要强调的内容**。

这是*补充性的强调*。

不要整段加粗。只突出关键词，页面会更容易阅读。

列表

无序列表：

- 第一项
- 第二项
- 第三项

有序列表：

1. 第一步
2. 第二步
3. 第三步

列表前后各留一个空行，可以减少排版问题。

链接

[南开大学官网](https://www.nankai.edu.cn/)

[] 内是链接内容，() 内是链接地址。

图片

![图片内容的简要说明](images/example.png)

图片说明应当让没有看到图片的人也能理解其用途。本站图片通常存放在相应栏目附近的 images 文件夹中，并使用英文、数字和连字符命名。

如果你不会上传图片，可以先提交文字，在 PR 说明中写明“希望补充图片”，并请维护者协助。

不要直接使用只能由自己访问的网盘或聊天软件图片地址。

引用

> 这是一段引用内容。

数学公式

行内公式使用 &：

理想气体状态方程为 $pV=nRT$。

效果：理想气体状态方程为 \(pV=nRT\)。

需要单独占一行的公式使用：

$$
pV=nRT
$$

本站内容建议

为了让指南长期保持可靠、易读，提交内容时请注意：

  • 说明时间范围：政策、课程和竞赛信息尽量标明年份；
  • 区分事实与经验：个人感受可以保留，但不要写成对所有人都成立的结论；
  • 保持友善克制：可以讨论问题，但避免对个人或群体进行攻击；
  • 写给不了解背景的人：首次出现的简称、地点和学院内部说法应作简单解释。

常见问题

  • 我只改一个错别字，也需要创建 PR 吗？

需要。流程相同，但修改很小，一般很快就能审核。

  • 我提交错了，会不会影响正式网站？

不会。PR 在被维护者合并之前不会进入正式网站。如果发现问题，可以在 PR 中留言说明。

  • 为什么提交后网站没有立即更新？

提交 PR 只是发出修改申请。维护者需要先审核并合并，之后网站还要自动构建和发布。

  • 我不会 Markdown，可以贡献吗？

可以。优先保证内容准确、表达清楚，基础格式问题可以由维护者协助调整。

  • 我找不到对应文件怎么办？

优先从本站目标页面右上角的编辑按钮进入，它会直接打开对应文件。如果仍然找不到，可以在仓库中提出 Issue，说明想修改哪个页面。

  • 我想新增一整页怎么办？

可以先提出 Issue，说明计划写什么、适合放在哪个栏目。确定结构后再写，可以避免与已有内容重复，也方便维护者帮助配置导航。

  • 维护者提出修改意见，是不是代表贡献没有通过？

不是。PR 的重要作用之一就是讨论和共同完善内容。根据留言继续修改或补充来源即可。

仍然需要帮助？

如果你对网站本身有建议、无法完成网页操作，或者希望更深入参与维护，可以发送邮件至 ncwzdlsd@gmail.com。请尽量说明目标页面、想修改的内容，以及遇到问题时页面上显示的提示。

评论