贡献指南

本站内容靠大家共同维护。任何形式的补充都欢迎，哪怕只是修正一个错别字。

可以贡献什么

• 补充页面里标注 待补充 的内容
• 修正过时的信息（价格、时间、地址、电话）
• 新增页面或整块内容
• 报告错误、提建议

内容原则

1. 真实：只写自己确认过的信息，不确定就标注"待核实"。
2. 客观：不写人身攻击，不泄露他人隐私（手机号、宿舍号、身份证等）。
3. 有时效：涉及价格、政策的内容，标注时间（如"截至 2026 年 3 月"）。
4. 不商业化：不夹带广告和推广链接。
5. 合法合规：不发布违法信息和敏感内容。

如何提交

方式一：GitHub PR（推荐）

git clone <仓库地址>
cd njfu-wiki
pnpm install
pnpm dev          # 本地预览，改完即时生效

# 新建分支，修改 docs/ 下的文件
git checkout -b add-dorm-info
git add .
git commit -m "补充 X 号楼宿舍信息"
git push origin add-dorm-info
# 然后在 GitHub 上开 Pull Request

提交前请确保：

pnpm build        # 必须能构建通过

方式二：提 Issue

不会用 Git 也没关系，把内容写在 Issue 里，维护者会帮忙录入。

写作规范

• 文件放在对应目录下：校园 docs/campus/、学习 docs/study/、生活 docs/life/
• 每页开头写 frontmatter：

---
title: 页面标题
description: 一句话说明
---

• 新增页面后，在 docs/.vitepress/config.mts 的 sidebar 和 nav 里登记
• 表格用于罗列对比，列表用于步骤
• 不确定的内容用待补充块标记：

::: warning 待补充
这里要写 XX 信息。
:::

不要做的事

• 不要提交 node_modules、构建产物 docs/.vitepress/dist
• 不要在页面里写具体同学的姓名、学号、宿舍号、手机号
• 不要提交来源不明的图片（注意版权）

联系方式

待补充

补充维护者的联系方式：邮箱 / QQ 群 / Issue 链接。