贡献说明 ​

贡献概述 ​

本文档欢迎内部员工、社区开发者、合作伙伴及广大用户共同参与文档共建贡献，可对现有文档进行纠错补全、内容优化、新增场景教程、补充英文翻译、更新版本特性等，共同维护文档完整性、准确性与易用性。

贡献范围 ​

1. 修正文档文字错误、操作步骤遗漏、参数描述不准、图文不符等问题；
2. 补充缺失的安装部署、配置调试、故障排查、接口使用等场景文档；
3. 优化现有文档结构、标题目录、语言表述，提升可读性；
4. 参与文档中译英、英文文档校对优化工作；
5. 同步更新版本迭代对应的新特性、功能变更、已修复问题等内容。

贡献方式 ​

1. 开发者可拉取对应 GitCode 代码仓库分支，本地修改文档内容后提交 PR；
2. 普通用户可通过仓库 Issue 提交文档错误反馈、优化建议及内容补充需求；
3. 内部人员可直接对接文档维护负责人，提交文档修改稿件或优化方案。

提交规范 ​

1. 严格遵循社区统一文档格式、标题目录规范及技术术语标准，保持风格统一；
2. 操作类文档步骤清晰、逻辑连贯，配图规范、路径准确；
3. 英文翻译需保证技术语义准确、句式专业，符合开源社区阅读习惯；
4. 提交 PR 时需清晰备注修改原因、修改内容及关联版本，便于审核合入。

文档合入 ​

1. 文档维护负责人对提交的 PR 及修改建议进行技术内容、格式规范双重审核；
2. 存在内容偏差、格式不规范的贡献内容，反馈修改意见后由贡献者调整重新提交；
3. 审核通过后统一合入主干分支，同步完成线上文档更新发布。

版权问题 ​

1、所有贡献内容版权归社区及所属项目所有，仅限项目官方文档使用；

2、优质持续贡献者可在社区贡献名单中进行署名展示；

3、禁止私自篡改核心技术文档、外传未正式发布文档内容。

咨询渠道 ​

若在文档贡献、修改编写、翻译规范过程中有疑问，可通过仓库 Issue、内部对接群联系文档维护人员进行咨询答疑。