贡献文档.md 3.9 KB
Newer Older
W
wenjun 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
# 贡献文档<a name="ZH-CN_TOPIC_0000001053069234"></a>

非常欢迎您贡献文档,我们鼓励开发者以各种方式参与文档反馈和贡献。您可以对现有文档进行评价、简单更改、反馈文档质量问题、贡献您的原创内容。

卓越贡献者将会在开发者社区文档贡献专栏表彰公示。

-   [贡献方式](#section5723203852414)
-   [写作规范](写作规范.md)

## 内容版权<a name="section87752266272"></a>

用户提交的内容、图片必须是原创内容,不得侵犯他人知识产权。

对应采纳的内容,OpenHarmony有权根据相关规范修改用户提交的内容。

## License<a name="section460934180"></a>

[Creative Commons License version 4.0](https://creativecommons.org/licenses/by/4.0/legalcode)

## 贡献方式<a name="section5723203852414"></a>

N
NEEN 已提交
22 23 24 25 26 27 28 29 30 31 32 33 34 35
### 反馈文档问题<a name="section133341053162416"></a>

高质量的问题反馈有助于我们不断完善文档内容和质量,您提供的信息越详尽,对我们问题改进越有帮助。

1.  在Gitee页面中,“Issue“页签中单击“新建Issue“,在标题栏中描述问题,在编辑框中添加详细问题描述。
2.  单击“创建“按钮,提交Issue,耐心等待文档团队成员确认您的问题。

>![](public_sys-resources/icon-note.gif) **说明:** 
>**如何反馈一个高质量的问题?**
>
>-   提供问题的清晰描述,描述具体缺失、过时、错误的内容或者需要改进的文字。
>-   解释该问题对用户的影响。
>-   将给定问题的范围限定在一个具体内容、任务。如果问题牵涉的领域较大,可以将其分解为多个小一点的问题。例如:"文档需要优化" 是一个过于宽泛的问题,而 "XX开发指南缺少对XXX步骤的介绍" 就是一个足够具体的、可操作的问题。
>-   搜索现有问题的列表,查看是否已经有相关的或者类似的问题已被记录。
N
NEEN 已提交
36
>-   如果新问题与某其他问题或PR有关联,可以使用其完整 URL 或带 \# 字符的PR编号来引用它。
N
NEEN 已提交
37 38

### 简单更改<a name="section1433285372417"></a>
W
wenjun 已提交
39 40 41 42

针对现有文档进行快速更改和修复,适合少量内容修改和补充。

1.  在文档页面右上角单击“编辑“按钮即可跳转到对应的Gitee工程源文件页面。
W
wusongqing 已提交
43
2.  在Gitee源文件md页面中,在对应内容处完成更改、修复。
W
wenjun 已提交
44
3.  修改完成后,可单击“预览“按钮,确认修改结果。
W
wusongqing 已提交
45
4.  确认无误后,在“扩展信息框“中填写修改意见和补充信息、Signed-off-by邮箱信息触发DCO校验,单击提交审核。
N
NEEN 已提交
46

W
wusongqing 已提交
47
    例如:Signed-off-by: user.name <user.email> //与DCO签署邮箱保持一致
N
NEEN 已提交
48 49

    ![输入图片说明](https://images.gitee.com/uploads/images/2021/0625/095714_92d8e459_7756659.png "屏幕截图.png")
W
wenjun 已提交
50 51 52 53 54 55

    文档团队成员将评审并合并您的修改内容,感谢您对OpenHarmony文档的支持和帮助。


更多内容可参考[贡献流程](贡献流程.md)

N
NEEN 已提交
56
### 为发行版本贡献文档
W
wenjun 已提交
57

N
NEEN 已提交
58
为了帮助开发者更高效使用OpenHarmony社区的每个Release版本,社区会根据每个版本规划的需求特性提供配套文档(如指南、API参考、开发示例、Release Notes、API Changelog、FAQ等)。有的需求涉及新增功能特性和文档,有的需求是对现有特性和文档内容更新。
W
wenjun 已提交
59

N
NEEN 已提交
60
欢迎开发者参与贡献,详细参考:[为发行版本贡献文档](docs-release-process.md)
W
wenjun 已提交
61

N
NEEN 已提交
62
### 贡献经验分享内容<a name="section12616152517159"></a>
W
wenjun 已提交
63 64 65

鼓励开发者在学习、开发过程中,总结经验并创建技术内容帮助更多开发者快速上手。推荐输出各类How to教程、常见问题FAQ等。请参考如下写作模板:

N
NEEN 已提交
66 67
-   [How to教程](template/tutorial-template.md):贡献至`contribute/tutorial`文件夹下。
-   [FAQ](template/faq-template.md):贡献至`contribute/faqs`文件夹下。
W
wenjun 已提交
68 69 70

内容写作模板归档在Docs文档仓下contribute文件夹中。