Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
131 lines (92 loc) · 3.42 KB

CONTRIBUTING.md

File metadata and controls

131 lines (92 loc) · 3.42 KB
Raw

贡献指南

感谢你对 OpenTYUT 的关注！这份指南帮助你高效地为项目做出贡献。

行为准则

OpenTYUT 是一个面向新手的友好社区。在任何互动中，请保持尊重、耐心和建设性。

  • Be nice. 每个人都是从新手过来的。
  • Be helpful. 如果看到你能回答的问题，欢迎帮忙。
  • Be constructive. 批评可以，但要给出改进建议。

我可以贡献什么

我擅长 我可以
某门课程学得好 补充课程笔记、学习心得、考试复习要点
用过好用的工具/网站 推荐到"外部资源"页面
发现网站有错误 提 Issue 或直接 PR 修正
写前端 改进网站样式、功能、交互
什么都不会但想帮忙 检查死链、修正错别字、转发给需要的同学

Issue 规范

提 Issue 之前

  1. 搜索已有 Issues，确认不重复
  2. 阅读 提问的艺术
  3. 选择合适的 Issue 模板

Issue 不会被回复的情况

  • 问题描述只有一句话，没有上下文
  • 明显可以在网站或搜索引擎找到答案的问题
  • 态度恶劣或不尊重他人

Pull Request 规范

分支命名

feat/xxx       新增内容或功能
fix/xxx        修复 bug 或错误
docs/xxx       文档相关
chore/xxx      杂项（配置、依赖等）

Commit 信息

采用 Conventional Commits：

feat: 新增后端开发 MySQL 笔记
fix: 修正 Git 指南中的死链
docs: 更新 README 贡献说明

PR 流程

  1. Fork 本仓库
  2. 创建你的分支
  3. 提交修改（遵循 commit 规范）
  4. 推送并创建 PR
  5. 等待 Review

PR 合并标准

维护者会检查以下事项：

  • 内容准确、来源可靠
  • 无敏感信息（个人信息、密码、密钥等）
  • 页面包含 frontmatter（title 和 description）
  • 排版清晰、链接有效
  • 未引入大量无关变更

内容规范

Markdown 排版

  • 标题层级合理，不跳级
  • 代码块标注语言类型
  • 外链使用完整 URL
  • 图片使用相对路径，放在 public/ 目录下

信息可靠性

  • 课程相关信息请确认与当前教学计划一致
  • 外链资源请确认链接有效、内容安全
  • 个人经验建议注明适用前提（"我当时……"、"某级某专业……"）

Frontmatter（SEO 必要）

每个 .md 页面文件开头必须包含以下 frontmatter：

---
title: 页面标题（显示在浏览器标签页和搜索结果中）
description: 页面描述（用于 SEO 和社交分享预览，建议 120-160 字）
---

示例：

---
title: 后端开发 | OpenTYUT
description: 后端开发方向学习路线和资源推荐。覆盖编程语言、数据库、操作系统、计算机网络、系统设计和工程实践。
---

新页面可复制 _template.md 作为起点。

标题规范：

  • 标题末尾建议带 | OpenTYUT 后缀，便于搜索引擎区分
  • 标题应准确反映页面内容，不要用模糊标题

描述规范：

  • 120-160 字以内，超过会被搜索引擎截断
  • 用一句完整的话概括页面内容
  • 不同页面不要复用相同的描述

本地开发

npm install
npm run dev

访问 http://localhost:5173 预览。

不需要前端知识即可参与内容贡献——直接在 GitHub 网页上编辑 Markdown 文件即可。