Contributing Documents
Welcome to contribute to the Cangjie documentation. You can evaluate, modify, provide feedback on existing documents, or contribute original content. We encourage developers to participate in document feedback and contributions in various ways.
Content Copyright
User-submitted content and images must be original and must not infringe on others' intellectual property rights.
Cangjie reserves the right to modify developer-contributed content according to relevant guidelines.
License
Creative Commons License version 4.0
Contribution Methods
Providing Feedback on Document Issues
High-quality feedback helps us continuously improve the content and quality of the documentation. The more detailed the information you provide, the more helpful it is for us to improve the issues.
- In the corresponding repository on GitCode, go to the "Issues" tab, click "New issue," describe the issue in the title bar, and add a detailed description of the problem in the editing box.
- Click the "New issue" button to submit your issue. Please wait patiently for the members of the Cangjie Document team to confirm your problem.
How to Provide High-Quality Feedback?
- Provide the specific location, name of the document, and a clear description of the issue. Specify the missing or incorrect content or the text that needs improvement, and provide screenshots if necessary.
- Explain the impact of the issue on users.
- If the issue is with a document example, provide the specific Cangjie version, environment, and error message.
- Limit the scope of the given issue to a specific content or task. If the issue involves a broad area, break it down into smaller issues. For example, "The documentation needs optimization" is too broad, while "The XX development guide lacks an introduction to the XXX steps" is a specific and actionable issue.
- Search the existing issue list to see if a related or similar issue has already been recorded.
- If the new issue is related to another issue or PR, you can reference it using its full URL or the PR number with the # character.
Online Changes
For quick changes and fixes to existing documents, suitable for minor content modifications and additions.
Submission Steps:
-
Click the "IDE" button in the upper right corner of the GitCode documentation page to jump to the corresponding project source file page.
-
On the GitCode source file page, complete the changes and fixes at the corresponding content.
-
After completing the modifications, you can click the Markdown preview button in the upper right corner of the page to confirm the modification results.
-
After confirming that everything is correct, fill in the modification comments and supplementary information, and the Signed-off-by email in the submission panel on the left.
Example:
Signed-off-by: user.name <user.email>// Ensure it matches the DCO signing email
The Cangjie Document team will review and merge your changes. Thank you for your support and assistance with Cangjie Document.
Local Changes
Suitable for scenarios requiring extensive modifications or additions.
Submission Steps:
- Fork the project repository.
- Clone the project to your local machine and create a branch for document changes.
- After completing the document changes locally, submit a PR.
- Wait for gatekeeper verification and review by the Cangjie Document team. Once approved, the changes will be merged.