-
-
Notifications
You must be signed in to change notification settings - Fork 981
Univer GitHub Issues Community Guide
To improve the efficiency of issue management and problem resolution, while ensuring the healthy development of the community, we have established the following rules and guidelines. Please read carefully before submitting an issue. Issues that do not comply with these rules will be closed directly.
Univer's issues are strictly for the following purposes:
- 🐛 Bug Reports: Clearly describe the issues in the software and provide sufficient details to help developers reproduce and fix them.
- 🚀 Feature Requests: Propose reasonable and universally valuable feature requests to enhance the functionality of the project.
Note
Univer implements specific features based on some characteristics of Microsoft Office / Google Workspace and generally does not support highly customized business-specific requirements.
Note:
Issues are not intended to resolve individual business problems or provide technical support. If you need assistance, please use the following resources:
- Read the official documentation: Univer Documentation
- Join the community discussion to seek help from other developers.
Before submitting an issue, please ensure that you have:
-
Checked the Documentation: Many problems can be resolved by reading the official documentation.
- For example: Permission Control Documentation
- Searched Existing Issues: Avoid submitting duplicate issues.
- Confirmed the Source of the Problem: Ensure that the issue is caused by Univer itself and not by your environment or third-party tools.
To help us understand and resolve issues more efficiently, please use our provided issue template when submitting your issue.
Unless under special circumstances, issues must include a minimal reproducible repository link. You can use the Vite online template to provide an online reproduction link or directly share a GitHub repository without any sensitive information.
The following types of issues will be closed directly:
- Issues not submitted using the template: For example, missing key details such as descriptions or reproduction steps.
-
Issues related to business problems: For example, requests to solve personalized needs or non-standard features.
- Example: "How can I customize cell styles using the API?"
- Duplicate Issues: Issues that already exist or are similar to existing ones.
- Issues unrelated to Univer: For example, problems caused by third-party tools or environments.
-
Q: My question is about how to implement a specific feature. Can I submit an issue?
A: It is not recommended to submit an issue. Please first check the official documentation or seek help in the community. If the problem is due to insufficient documentation, you can submit a suggestion for documentation improvement. -
Q: I found a bug but cannot provide reproduction steps. What should I do?
A: Try to provide as much information as possible, including error logs, screenshots, etc. Developers may not be able to address the issue if it cannot be reproduced. -
Q: I have a great feature idea. Can I submit an issue?
A: Yes, but please ensure that the suggestion is universally valuable and describe its value and use case in detail.
We welcome community members to participate in the project through the following ways:
- Submit PRs: Fix bugs or add features.
- Improve Documentation: Help enhance the official documentation of the project.
- Answer Questions: Help other developers solve problems in the community.
If your issue does not comply with the above rules, we will:
- Close the Issue Directly: And provide a comment explaining the reason for closure.
- Suggest Improvements (if applicable): Provide suggestions for modifications, allowing you to resubmit the issue or reopen the original one.
Thank you for your support and cooperation with Univer! By following these rules, we can maintain an efficient and friendly community environment together.