欢迎参与仓颉文档贡献。您可以对现有文档进行评价、更改、反馈问题或贡献原创内容,我们鼓励开发者以各种方式参与文档反馈和贡献。
用户提交的内容、图片必须是原创内容,不得侵犯他人知识产权。
仓颉有权根据相关规范修改开发者贡献的内容。
Creative Commons License version 4.0
高质量的问题反馈有助于我们不断完善文档内容和质量,您提供的信息越详尽,对我们问题改进越有帮助。
- 在 GitCode 对应仓库中,进入“Issues”页签,单击“新建 Issue”,在标题栏中描述问题,在编辑框中添加详细问题描述。
- 单击“新建 Issue”按钮,完成 Issue 提交。请耐心等待仓颉文档团队确认您的问题。
如何反馈一个高质量的问题?
- 提供文档的具体位置、名称以及问题的清晰描述,给出具体缺失或错误的内容或者需要改进的文字,必要时提供截图。
- 解释该问题对用户的影响。
- 如果是文档示例错误,请提供具体执行的仓颉版本、环境、及报错信息。
- 将给定问题的范围限定在一个具体内容、任务。如果问题牵涉的领域较大,可以将其分解为多个小一点的问题。例如:“文档需要优化” 是一个过于宽泛的问题,而 “XX 开发指南缺少对 XXX 步骤的介绍” 就是一个足够具体的、可操作的问题。
- 搜索现有问题的列表,查看是否已经有相关的或者类似的问题已被记录。
- 如果新问题与某其他问题或 PR 有关联,可以使用其完整 URL 或带 # 字符的 PR 编号来引用它。
针对现有文档进行快速更改和修复,适合少量内容修改和补充。
提交步骤:
-
在 GitCode 文档页面右上角单击“IDE”按钮即可跳转到对应的工程源文件页面。
-
在 GitCode 源文件页面中,在对应内容处完成更改、修复。
-
修改完成后,可单击页面右上角 Markdown 预览按钮,确认修改结果。
-
确认无误后,在左侧提交面板中填写修改意见和补充信息、Signed-off-by 邮箱信息触发校验,选择合入的分支,单击“提交”完成修改。
例如:
Signed-off-by: user.name <user.email>//与 DCO 签署邮箱保持一致
仓颉文档团队成员将评审并合并您的修改内容,感谢您对仓颉文档的支持和帮助。
适合需要修改或补充较多内容的场景。
提交步骤:
- Fork 项目仓库。
- Clone 项目到本地,并创建文档变更分支。
- 本地完成文档更改后提交 PR。
- 等待门禁验证和仓颉文档团队成员审核,通过后合入。