Skip to content

Univer GitHub Issues 社区手册

白熱 edited this page Jun 10, 2025 · 1 revision

为了更高效地管理和解决问题,同时确保社区的健康发展,我们制定了以下规则和指南。请在提交 issue 前仔细阅读,未遵守以下规则的 issue 将会被直接关闭。

1. Issue 的用途

Univer 的 issue 仅用于以下两种情况:

  • 🐛 Bug 报告:明确描述软件中的问题,提供足够的细节以便开发者复现和修复。
  • 🚀 功能需求:提出合理的、具有普遍性价值的功能需求,帮助提升项目的功能性。

Note

Univer 依据 MicroSoft Office / Google Workspace 的部分特性来实现具体的功能,通常不会为业务化程度较高的需求提供支持。

注意

Issue 不用于解决用户的个性化业务问题或技术支持请求。如果您需要帮助,请通过以下方式获取支持:

  • 阅读官方文档:Univer 官方文档
  • 加入社区讨论,寻求其他开发者的帮助。

2. 提交 issue 前的准备

在提交 issue 前,请确保您已经:

  1. 检查文档:许多问题可以通过阅读官方文档解决。
  2. 搜索已有 issue:避免重复提交相同的问题。
  3. 确认问题的来源:确保问题是由 Univer 本身引起的,而非使用环境或第三方工具的问题。

3. 提交 issue 的要求

为了帮助我们更快地理解和解决问题,请确保您通过我们提供的 issue template 填写提交问题。 如无特殊情况,Issues 必须包含一个最小的可用于复现问题的仓库链接,你可以使用 Vite 在线模板 来提供一个在线复现链接,或者直接提供一个未包含任何敏感信息的 GitHub 仓库。

4. 不符合要求的 Issue

以下类型的 Issue 将会被直接关闭:

  • 未按照模板提交的 issue:如缺少描述、复现步骤等关键信息。
  • 与业务问题相关的 issue:如请求解决个性化需求或非标准功能。
    • 示例:“如何通过 API 自定义单元格样式?”
  • 重复提交的 Issue:已存在相同或相似问题。
  • 与 Univer 无关的问题:如因第三方工具或环境导致的问题。

5. 常见问题解答

  • Q: 我的问题是关于如何实现某个功能的,能提交 issue 吗?
    A: 不建议提交 issue。请先查阅官方文档或在社区中寻求帮助。如果确实是文档不足导致的问题,您可以提交文档改进建议。

  • Q: 我发现了一个 Bug,但无法提供复现步骤怎么办?
    A: 尽量提供尽可能多的信息,包括错误日志、截图等。如果无法复现,开发者可能无法处理该问题。

  • Q: 我有一个很好的功能建议,是否可以提交 issue?
    A: 可以,但请确保该建议具有普遍性,并详细描述其价值和用途。


6. 社区贡献

我们欢迎社区成员通过以下方式参与项目:

  • 提交 PR:修复 Bug 或添加功能。
  • 改进文档:帮助完善项目的官方文档。
  • 回答问题:在社区中帮助其他开发者解决问题。

7. 违规处理

如果您的 issue 不符合上述规则,我们将:

  1. 直接关闭 issue:并在评论中告知关闭原因。
  2. 建议改进(如果适用):提供修改建议,您可以重新提交符合要求的 issue 或者打开原来的 issue。

感谢您对 Univer 的支持与合作!通过遵守这些规则,我们可以共同维护一个高效、友好的社区环境。

Clone this wiki locally