社区贡献与维护指南
1. 目的
本指南用于建立 Azek431/cysj-data 资料库与 cysjdocs.dpdns.org 文档站的社区贡献与维护标准，降低新贡献者门槛，提升协同质量。
适用对象
- 贡献文档、专题、OCR 证据的社区作者
- 修复链接、补充导航、增强维护流程的维护者
- 设计站点结构、部署与运维方案的开发者
贡献流程
- 先在仓库中创建 issue，说明你要补充的模块或修复的页面。
- 关联 issue 后，基于
main创建分支，建议命名规则：fix/<问题编号>-<描述>feature/<模块>-<描述>docs/<章节>-<说明>
- 提交 PR 前，请确保：
- 相关文档存在清晰的元信息字段；
- 是否存在对应
docs/栏目且链接可访问； - 已在页面中补齐
来源文件、证据等级、最后更新； - 对导航、侧边栏、相关索引页的链接进行复查；
- 如果修改了页面结构，已确认无死链。
- 发起 PR 时，关联 issue，补充
修复内容、测试方式、是否添加新页面。
文档贡献规范
- 所有页面须补充统一头部字段：
分类、子系统、关键词标签、来源类型、证据等级、完整度状态、版本号、来源文件、最后更新
- 尽量使用简明中文标题，避免过长。
- 结论类语句需明确证据来源：
[已确认]、[高可信推断]、[待验证]。 - 避免发布绝对性结论，除非直接来自官方教程或更新说明。
- 对于 OCR / 图片编号引用，必须补齐对应
docs/OCR资料/映射表/OCR 图片编号映射表.md回链。
页面审查标准
请在 PR 评审时重点检查：
- 页面内容是否存在死链或无效引用。
- 目录是否与
docs/总索引与导航/创游世界知识库总导航.md一致。 - 新增页面是否补充了
关联文档、适合查询等辅助字段。 - 是否遵循
docs/元信息/知识条目统一元数据规范.md的模板。
开发者协作规则
- 新增页面优先在已有模块中创建，不推荐随意新增顶级目录。
- 内容修订建议使用
docs/维护与报告/维护检查清单.md的优先级判断。 - 重要改动（如导航重构、VitePress 配置变更、搜索优化）需先发 issue 讨论。
长期维护与交接机制
每周检查项
- 更新日志是否同步写入
docs/维护与报告/更新日志入口导航.md。 - 核心导航页、侧边栏、首页是否仍然可用。
- OCR 证据入口是否持续补齐新的编号映射。
- 是否存在
待验证问题。
交接机制
- 若主维护者暂停更新，建议至少保留一名社区协作者作为备份联系人。
- 维护者交接时，应同步：
- 当前 issue / PR 状态；
- 关键待补清单；
- 站点部署与自动构建配置；
- 站点备份与恢复方案。
停更预案
如果站点进入长期停更，应至少保留：
- 最新的仓库代码与
docs/内容。 docs/public/robots.txt、docs/public/sitemap.xml。README.md中说明当前停更状态与继续贡献入口。- 公告页面或
docs/关于.md中写明停止维护说明。
备份与恢复
- 仓库即是最基础的版本备份。
- 额外建议定期导出
docs/目录的静态文件与docs/public的静态资产。 - 站点部署建议开启自动构建日志和历史记录，以便恢复到可用版本。
贡献模板示例
- PR 标题示例：
docs: 补充新手阅读路线中核心导航入口 - Issue 标题示例：
docs: 修复 OCR 证据入口链接错误 - 分支示例：
docs/new-oct-ocr-template