OpenTelemetry 中文文档贡献指南

可贡献的内容

您可以从以下的方式中,选择您的贡献方向

  • Issue 中被标记 help want Label。
  • README.md 目录中未被标记 🚧 或者 ✅ 的文章。
  • 修复文档格式(如标点、空格、缩进、代码块等)和错别字
  • 修改过时,不当,不清晰的内容描述
  • 其他您认为有价值的事情。

贡献流程

  1. 创建相应的 Issue 或在已有的 Issue 下留言。让别人知道你的进展。
  2. 请复制原始英文(项目目录 /original 中),并在进行翻译时将其注释。
  3. 在翻译过程中,请及时创建 PR,并勤提交进展。对还在进展的 PR,请不用紧张,设置成 Draft PR 即可 :)
  4. 在完成翻译后,请及时进行更正,知道 reviewer 批准为止。
  5. 批准最终将被 CODEOWNERS 的人员合并。👏

快速上手资源

PingCAP 中文文档风格指南

中文技术文档协作规范

LeanCloud 文案风格指南

中文文案排版指北

项目日常维护

  1. 当源 spec repo 发生 release 时,将复制一份到 /original

参考资料

https://github.com/open-telemetry/docs-ja

https://github.com/pingcap/docs-cn/blob/master/CONTRIBUTING.md