You are welcome to make contributions to documentation. You can offer your feedback and contributions in various ways. You can evaluate available documents, make simple modifications, provide feedback on document quality, and contribute your original content.
You are welcome to make contributions to OpenHarmony documentation, in any of the methods provided below. You can help us improve the existing documents or submit new, original content.
Excellent contributors will be awarded and the contributions will be publicized in the developer community.
### Submitting Issues for Existing Documents<a name="section133341053162416"></a>
You can perform the following steps to modify a document or supplement some content:
Your feedback matters. Submit issues and leave as detailed information as possible, so we can better fix the issues and improve our documents.
1. In the upper right corner of the document page, click **Edit** to go to the source file page in the Gitee project.
2. On the page of the source file in **.md** format, click **Edit** to modify or supplement the file.
3. After the modification, click **Preview** to confirm the modification result.
4. Enter your comments and supplementary information in the **Extended Information** text box and click **Submit**.
1. On the Gitee page, click the **Issues** tab. On the displayed page, click **New issue**. Then enter the issue title and issue details.
2. Click **New** to submit the issue. The Docs team will confirm the issue.
The document team will review your modifications and update the file content accordingly. You will be appreciated for your support and contributions for the OpenHarmony documentation.
>- Provide a clear description of the issue, including the missing, outdated, incorrect, or to-be-improved content.
>- Explain the impact of this issue on users.
>- Limit the scope of the given issue to a specific task. If multiple fields are involved, break the issue down into smaller ones. For example, "Documents need to be optimized" is a broad issue, whereas "XX development guide lacks introduction to step XXX" is specific and operable.
>- Search the list of existing issues to see if any related or similar issues have been submitted.
>- If an issue is associated with another issue or a pull request (PR), you can use its full URL or the combination of the number sign (#) and PR number to reference it.
For more information, see [Contribution Process](contribution-process.md).
You can perform the following steps to modify or supplement a file:
## Feedback on Documentation<a name="section133341053162416"></a>
1. In the upper right corner of the document page, click **Edit** to go to the source file page in the Gitee project.
2. On the page of the source file in .md format, modify or supplement the file.
3. After the modification, click **Preview** to confirm the modification result.
4. Enter your comments, supplementary information, and Signed-off-by information in the **Extended Information** text box, and click **Commit**.
High-quality feedback helps us continuously improve the documents. The more detailed information you provide, the more helpful it is for us to solve problems.
Format of Signed-off-by information is as follows:
1. On the Gitee page, click the **Issue** tab. On the displayed page, click **New issue**. Then enter the issue title and issue details.
2. Click **New** to submit the issue. The document team will confirm the issue.
Signed-off-by: user.name <user.email> // Note that *user.name* and *user.email* must be the same as those used for DCO signing.
>- Provide a clear description of the issue, including the missing, outdated, incorrect, or to-be-improved content.
>- Explain the impact of this issue on users.
>- Limit the scope of the given issue to a specific task. If many fields are involved, break the issue down into smaller ones. For example, "Documents need to be optimized" is a broad issue, whereas "XX development guide lacks introduction to step XXX" is specific and operable.
>- Search the list of existing issues to see if any related or similar issues have been submitted.
>- If an issue is associated with another issue or a pull request, you can use its full URL or PR number with the number sign \(\#\) to reference it.
The Docs team will review your edits and update the file accordingly.
For more information, see [Contribution Process](contribution-process.md).
### Contributing Documents to a Release
To help developers efficiently use each release, OpenHarmony provides related documents (such as development guidelines, API reference, codelabs, release notes, API changelog, and FAQs) based on the requirements planned for the release. Some requirements involve new features and documents, and some require updates to the existing features and documents.
You are welcome to contribute documents to the release. For details, see [Writing Documents for a Release](docs-release-process.md).
You are encouraged to summarize experience and create technical content during learning and development to help more developers quickly get started. Tutorials and FAQs are recommended. The following templates are for reference:
-[Tutorial: Title \(Task Name\)](tutorial-title-(task-name).md)
-[Title \(Briefly Describe the Key Information of the Issue.\)](title-(briefly-describe-the-key-information-of-the-issue-).md)
You are welcome to share your experience and expertise with other developers to help them get started. For example, you can contribute tutorials and FAQs by using the following templates:
The writing templates are archived in the **contribute** folder in the **Docs** repository.
