贡献指南
🎯 贡献方式
Section titled “🎯 贡献方式”欢迎所有 BUPT 同学为生存手册贡献内容！您可以通过以下方式参与：
📝 内容贡献
Section titled “📝 内容贡献”- 更新校园信息：提供最新的校园政策、设施变化等信息
- 分享生活经验：分享您的校园生活心得和实用技巧
- 补充遗漏内容：添加手册中未涵盖的重要信息
- 纠正错误信息：指出并修正过时或错误的内容
🛠️ 技术贡献
Section titled “🛠️ 技术贡献”- 改进文档结构：优化导航和内容组织
- 修复技术问题：解决网站显示或功能问题
- 优化用户体验：改善页面设计和交互体验
- 添加新功能：为网站添加实用的新特性
📋 贡献流程
Section titled “📋 贡献流程”1. 准备工作
Section titled “1. 准备工作”Fork 项目：
- 访问项目仓库：https://github.com/byrdocs/SurviveBUPTManual
- 点击右上角的 “Fork” 按钮
- 将项目 fork 到您的 GitHub 账户
克隆仓库：
git clone https://github.com/YOUR_USERNAME/SurviveBUPTManual.gitcd SurviveBUPTManual2. 本地开发
Section titled “2. 本地开发”安装依赖：
pnpm install启动开发服务器：
pnpm dev访问本地站点：
打开浏览器访问 http://localhost:4321
3. 内容编辑
Section titled “3. 内容编辑”文档结构：
src/content/docs/├── index.mdx # 首页├── acknowledgments.md # 致谢页面├── contributing.md # 贡献指南├── shahe-campus/ # 沙河校区指南│ ├── registration.md│ ├── campus.md│ ├── dormitory.md│ ├── academic.md│ ├── life.md│ ├── intranet.md│ ├── military-training.md│ ├── organization.md│ └── misc.md├── main-campus/ # 本部校区指南│ ├── registration.md│ ├── dormitory.md│ ├── life.md│ ├── academic.md│ ├── dining.md│ ├── transportation.md│ └── services.md└── reference/ # 参考资料4. 提交更改
Section titled “4. 提交更改”创建新分支：
git checkout -b feature/your-contribution-name添加更改：
git add .git commit -m "feat: 添加XXX内容" 或 "fix: 修正XXX错误"推送到远程仓库：
git push origin feature/your-contribution-name5. 创建 Pull Request
Section titled “5. 创建 Pull Request”- 访问您的 fork 仓库页面
- 点击 “Compare & pull request” 按钮
- 填写 PR 标题和描述
- 提交 Pull Request
📖 内容规范
Section titled “📖 内容规范”Frontmatter 格式：
---title: 页面标题description: 页面描述，会显示在搜索结果中---Markdown 规范：
- 使用标准 Markdown 语法
- 标题层级：一级标题用于页面主标题，二级标题用于主要章节
- 代码块使用围栏式代码块（```）
- 列表使用
-或数字编号 - 链接格式：
[链接文字](URL)
准确性：
- 确保信息的准确性和时效性
- 注明信息的更新时间（如适用）
- 对于可能变化的信息，提醒读者关注官方最新通知
实用性：
- 提供具体、可操作的建议
- 包含必要的步骤和注意事项
- 避免过于抽象或空泛的内容
友好性：
- 使用亲切、友好的语调
- 考虑新生的视角和需求
- 避免使用过于专业的术语，必要时进行解释
结构化：
- 使用清晰的标题结构
- 合理使用列表和表格
- 重要信息使用引用块或特殊标记
图片要求：
- 图片存放在
src/assets/目录下 - 使用描述性的文件名
- 优先使用 WebP 或 PNG 格式
- 图片大小控制在合理范围内
引用格式：
🎨 样式指南
Section titled “🎨 样式指南”表情符号使用
Section titled “表情符号使用”适当使用表情符号可以让内容更加生动，建议：
- 章节标题：🏫 🏠 📚 🍽️ 🚇 等
- 重要提示：💡 ⚠️ 🔔 ✅ ❌ 等
- 评价推荐：⭐ 👍 👎 💝 等
重要提示：
> 💡 **提示**：这里是重要信息> ⚠️ **注意**：这里是需要注意的事项> ✅ **推荐**：这里是推荐的做法> ❌ **避免**：这里是不推荐的做法评分系统： 使用星级评价：⭐⭐⭐⭐⭐（五星制）
🔍 内容审核
Section titled “🔍 内容审核”所有贡献的内容都需要经过审核：
内容质量：
- 信息准确且实用
- 语言表达清晰
- 格式规范统一
- 结构组织合理
价值评估：
- 对目标用户有实际帮助
- 内容具有一定的普适性
- 不与现有内容重复
- 符合项目整体定位
审核过程中可能会有以下反馈：
- 直接合并：内容优质，无需修改
- 建议修改：提供具体的修改建议
- 需要补充：要求补充更多信息或细节
- 暂不采纳：暂时不适合加入，说明原因
🤝 社区规范
Section titled “🤝 社区规范”友善互助：
- 尊重所有贡献者
- 提供建设性的反馈
- 耐心帮助新手贡献者
- 营造包容的社区环境
质量优先：
- 对内容质量负责
- 积极参与讨论和改进
- 遵循项目的标准和规范
- 持续学习和进步
GitHub Issues：
- 报告问题和错误
- 提出改进建议
- 讨论新功能
Pull Request 讨论：
- 代码和内容 review
- 技术问题讨论
- 协作开发
💡 贡献建议
Section titled “💡 贡献建议”以下类型的贡献特别欢迎：
高优先级：
- 校园政策更新（如新规定、设施变化等）
- 重要信息纠错（如联系方式、地址变化等）
- 新生常见问题解答
- 实用生活技巧分享
中优先级：
- 内容补充和完善
- 用户体验优化
- 文档结构改进
- 新功能建议
低优先级：
- 样式和排版优化
- 性能提升
- 代码重构
- 文档翻译
内容创作：
- 站在新生角度思考
- 提供具体的操作步骤
- 包含必要的背景信息
- 考虑不同情况和选择
技术贡献：
- 遵循项目的技术栈
- 保持代码简洁和可维护
- 添加必要的注释和文档
- 确保兼容性和性能
📞 联系我们
Section titled “📞 联系我们”如有任何问题或建议，欢迎通过以下方式联系：
- GitHub Issues：https://github.com/byrdocs/SurviveBUPTManual/issues
- 项目讨论：在相关 Pull Request 或 Issue 中讨论
- Email：如果有敏感信息需要私下沟通
感谢您对 BUPT 生存手册的贡献！您的每一份努力都将帮助到更多的同学。