# 贡献文档

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

## 贡献方式

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

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

### 简单更改

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

1. 在文档页面右上角单击“编辑“按钮即可跳转到对应的 Gitee 工程源文件页面。
2. 在 Gitee 源文件 md 页面中，在对应内容处完成更改、修复。
3. 修改完成后，可单击“预览“按钮，确认修改结果。

### 贡献 RN 三方库使用文档

新增 HarmonyOS 化 RN 三方库使用文档：

1. 参考[文档](https://gitee.com/react-native-oh-library/docs/blob/master/zh-cn/third-party.md)将三方库按纯 JS 库/JS 库/原生库进行分类，并且根据[模板](/zh-cn/model.md)撰写不同类型的使用文档，然后放入 `/zh-cn` 目录下。

2. 文档命名样例：

```md
// 以原库 npm 包名为准
@react-native-community/slider -> react-native-community-slider.md
react-native-pager-view -> react-native-pager-view.md
```

3. 使用[prettier](https://github.com/prettier/prettier)格式化文档，`prettier --write ./xx.md` ；或者使用 VSCode 的 prettier 插件。

4. 在根目录 **Menu.xlsx** 新增三方库的信息。新增之后使用 Excel 转 MarkDown 工具转换成 MarkDown 表格：[Table to Markdown](https://tabletomarkdown.com/convert-spreadsheet-to-markdown/)。然后覆盖[README.md](../README.md)和[zh-cn/README.md](/zh-cn/README.md)中的表格信息。


5. 在根目录 \_sidebar.md 添加使用文档导航栏配置。

6. 运行`docsify serve` 查看[docsify](https://docsify.js.org/#/quickstart)效果。请确保已安装 docsify-cli，可以通过 `npm i docsify-cli -g` 安装。

7. 新建相关 issue，按[校验规则](https://gitee.com/react-native-oh-library/usage-docs/push_config)commit 并提交 PR 到本仓，等待审核人员合入。

   ```md
   `commit 信息模板`
   [Issues: #I8K7DK] 新增 react-native-svg 文档
   ```