投稿指南

感谢你愿意为成理工程生存指南与飞跃手册贡献内容。本页面说明投稿方式、模板选择和内容审核要求。

投稿方式

方式一：GitHub Pull Request（推荐）

1. Fork 仓库

点击仓库右上角 Fork 按钮，将 cdutetc-tieba/CDUTETC-Guide 复制到你的账号下。

2. 克隆你的 Fork

git clone https://github.com/你的用户名/CDUTETC-Guide.git
cd CDUTETC-Guide
git remote add upstream https://github.com/cdutetc-tieba/CDUTETC-Guide.git

3. 创建分支并编写内容

git checkout -b feat/你的功能名称

在对应目录下创建新的 Markdown 文件，参考下方模板和规范编写内容。

4. 提交前检查

pnpm format        # 格式化 Markdown
pnpm lint          # 检查 Markdown 规范
pnpm docs:build    # 验证构建

5. 提交并推送

git add .
git commit -m "feat: 描述你的修改"
git push origin feat/你的功能名称

6. 提交 Pull Request

在 GitHub 上创建 PR（从你的 fork 分支 → cdutetc-tieba/main），等待审核合并后自动上线。

方式二：邮件投稿

如果你不熟悉 Git 操作，可以将内容以 Markdown 或 Word 文档形式发送至邮箱：

投稿邮箱：cdutetc.tieba@outlook.com

由维护者代为整理和上架。请在邮件中注明投稿分区，并留下便于核对内容的联系方式。邮件投稿不要求提前整理 Markdown 或 frontmatter。

---

投稿模板

不同文章承担的任务不同，不使用一套万能结构。仓库在 docs/templates/ 中提供以下模板：

投稿内容	模板文件	重点
校园办事与生活实用信息	survival-entry.md	适用条件、具体流程、失败点、替代办法和更新时间
校园处境与观点文章	survival-perspective-entry.md	一个明确问题、形成机制、选择影响和适用边界
考研经历	leap-postgraduate-entry.md	择校、时间线、投入、调整、初复试结果和经验边界
留学申请经历	leap-abroad-entry.md	选校、预算、申请过程、拒信或调整、结果和政策时效
就业或实习经历	leap-employment-entry.md	方向验证、投递、面试、拒绝、入职结果和行业时效

模板中的注释用于提醒需要回答的问题，不是必须保留的章节。请删除不适用的小节，并把占位标题改成文章真正要处理的问题。

生存指南怎么写

实用条目应帮助读者完成一件事或避开一个具体问题，优先写清：

• 适用对象、办理时间和前置条件；
• 地点、材料、费用、步骤和确认结果的方法；
• 容易失败的环节、处理窗口和替代方案；
• 信息来源和最后核验日期。

处境或观点文章不需要添加固定的 Tips 和励志结尾。文章应只处理一个中心问题，说明问题如何形成、它会改变什么选择，以及结论在哪些条件下不成立。

飞跃手册怎么写

飞跃手册案例是可比较的个人样本，不是通用成功教程。正文至少需要交代：

• 与选择和结果相关的背景及现实约束；
• 为什么选择这条路，以及比较过哪些替代方案；
• 时间、金钱和精力投入，失败、拒绝或中途调整；
• 最终结果，而不只展示最好的一次成绩或 offer；
• 哪些经验可以参考，哪些依赖个人基础、年份、地区或行业周期。

作者可以在页面中匿名或模糊隐私信息，但维护者需要通过私下材料确认经历来源。访谈稿必须取得受访者明确授权。

---

文件命名规范

• 使用英文短横线命名（kebab-case）
• 简短且有意义
• 示例：postgraduate-experience.md、dorm-life-guide.md

Frontmatter 说明

所有文章都需要填写基础字段：

---
title: 文章标题
order: 99 # 生存指南文章使用；数字越小越靠前
description: 文章解决的问题或样本背景
date: YYYY-MM-DD # 飞跃手册案例使用
---

飞跃手册案例还需要填写与栏目筛选器一致的字段：

栏目	必填筛选字段	示例
考研	year、target、major、zone、degree、cross	2025、双一流、计算机、A区、专硕、跨考
留学	year、region、major	2025、中国香港、商科
就业	year、industry、type	2025、制造业、技术岗

这里的 major 指报考或申请方向，type 在就业栏目中指岗位类型。投稿方向由文件所在目录确定，不再使用 type: 考研 | 出国 | 就业 这类通用字段。

留学案例的 region 填写具体目的地，例如“中国香港”“英国”“日本”，不要填写“亚洲”或“欧洲”；大洲分组由页面自动生成。

内容规范

• 使用 Markdown 语法
• 明确区分亲历、转述、编辑判断和仍待核实的信息
• 政策、费用、时间、考试科目、申请要求和招聘规则应注明来源与查询日期
• 只提交本人经历或已获得明确授权的访谈，不拼接或虚构上岸、录取和就业案例
• 飞跃手册案例必须说明与结论相关的背景、投入、失败和结果，不把单一个案写成普遍规律
• 删除无法核实的精确数字、万能结论、空泛寄语和为了完整而添加的固定段落
• 尊重他人隐私
• 不包含敏感或违规内容
• 代码块需指定语言（如 ```bash、```text）

投稿前自检

• 文章是否让读者看清或完成了一件具体的事？
• 重要结论是否有事实、经历或来源支撑？
• 建议是否说明了适用对象、成本和失效条件？
• 飞跃手册案例是否包含真实结果，而不是只写准备方法？
• 删除最后一段祝福或总结后，文章是否反而更清楚？如果是，删除它。

常见 CI 问题

Prettier 格式检查失败

运行 pnpm format 自动修复。

Markdownlint 规范检查失败

运行 pnpm lint:fix 自动修复，或查看错误提示手动修改。

构建失败

运行 pnpm docs:build 查看具体错误信息。

内容审核

所有内容提交后会经过审核，审核通过后合并到主分支并自动部署。

---

如有问题，请通过 GitHub Issues 反馈。