Skip to content

贡献与变更

本地开发说明

bash
pnpm install
vpr dev

提交前执行:

bash
pnpm verify

运行该命令可一次性校验代码格式、TypeScript 类型、静态构建、文档内部链接、色彩对比度、SVG/PNG 资产一致性以及核心页面无障碍表现。

源文件规则

  • 调整 Logo 图案:修改 assets/logo/source 后,运行 pnpm assets:build 以重新生成导出物。
  • 变更颜色、间距与主题样式:集中修改 apps/docs/.vitepress/theme/custom.css,并检查亮暗主题。
  • 完善规范条目:编辑对应页面内容时,需在 CHANGELOG.md 中同步追加更新记录。
  • 严禁直接编辑生成的 PNG 图片或规范网站中的下载副本。

变更级别

  • Patch:错别字、说明补充、不改变用法的资产修正。
  • Minor:新增模板或向后兼容的规范。
  • Major:改变 Logo 构成或修改既有规范语义。

对于破坏性变更,必须提供详细的迁移指南,并保留至少一个次要(Minor)版本的废弃过渡期。

品牌变更评审

Logo、品牌名称、主色和授权边界由组织维护者批准。评审需要包含动机、受影响资产、小尺寸和单色预览、亮暗背景测试以及无障碍影响。

内容贡献

制定的规则应描述为可度量、可验证的行为,避免采用“现代、简洁、舒适”等无法客观执行的形容词。编写的示例数据严禁包含真实的学生信息、账号、访问令牌或未经授权的学校内部机密资料。

基于 CC BY-NC 4.0 许可协议共享