mirror of
https://github.com/iflytek/skillhub.git
synced 2026-09-06 08:15:57 +00:00
1.8 KiB
1.8 KiB
档案贡献指南
目标
档案库应当容易扩展,而不是一开始就要求贡献者把所有事情都想清楚。推荐的写法是:
- 条目小而清晰,并且互相有链接
- 日期明确
- 来源引用直接可见
- 尽量减少重复
新增材料
- 如果材料还没准备好归类,先放进
inbox/。 - 当一份材料未来可能被引用时,创建对应的
sources/条目。 - 更新相应月份的
timeline/文件。 - 只有在“综合整理”本身有价值时,才把材料提升到
milestones/、decisions/、contributors/或narratives/。
编辑规则
- 优先补充带来源的事实,不要凭记忆写大段概述。
- 一个文件只聚焦一个主题。
- 尽量链接已有文档、PR、issue 或提交,而不是复制大段原文。
- 如果确实需要新的档案分类,先更新
_meta/taxonomy.md。
如何处理不完整信息
- 用
status: seed表示第一版骨架,且已有可验证锚点。 - 用
status: draft表示内容还不完整,但已经可以阅读。 - 用
status: curated表示结构和证据已经足够扎实,可被后续复用。
适用范围
适合进入档案的内容:
- 一个重要想法首次出现的时刻
- 改变方向、范围、架构或工作流的里程碑
- 能解释某个选择为何发生的贡献者讨论
- 影响项目传播或认知的外部提及
除非确有需要,否则不建议完整保存以下内容:
- 没有摘要的原始聊天导出
- 冗长 PR 描述的重复拷贝
- 文章全文复制
- 低信号的运维噪音
复核清单
在把一条记录视为稳定之前,请检查:
- 日期是否明确
- 文件类型是否正确
- 是否至少有一条具体来源
- 敏感信息是否已经脱敏或改写为摘要
- 文件是否链接到了档案中的下一处相关内容