菜单

贡献

相关源文件

本文档概述了为 drawio-desktop 项目做出贡献的指南和流程。它涵盖了问题报告、功能请求和代码贡献。有关设置开发环境的信息,请参阅 设置,有关了解代码库结构,请参阅 代码结构

贡献政策

drawio-desktop 项目的贡献政策是受限制的。由于代码库的复杂性,即使是小的更改也可能影响许多相互关联的组件,因此该项目通常不对代码贡献开放,除非在维护者特别允许的罕见情况下。

来源:README.md56-69

如何贡献

虽然代码贡献很少被接受,但该项目欢迎其他类型的贡献

  1. Bug 报告:报告您在使用应用程序时遇到的问题
  2. 功能请求:建议新功能或改进
  3. 文档:在某些情况下,可以考虑改进文档

Bug 报告流程

要报告 bug,请使用 bug 报告模板创建一个新的 issue,并包含以下信息

  1. 对 bug 的清晰描述
  2. 重现问题的步骤
  3. 预期行为
  4. 截图(如果适用)
  5. 您的 draw.io 版本
  6. 您的操作系统信息
  7. 有助于诊断问题的任何其他上下文

来源:.github/ISSUE_TEMPLATE/bug_report.md1-40

功能请求流程

要请求新功能,请使用功能请求模板创建一个新的 issue 并包含

  1. 您的功能将要解决的问题
  2. 您提出的解决方案的清晰描述
  3. 您考虑过的任何替代解决方案
  4. 其他上下文或屏幕截图

来源:.github/ISSUE_TEMPLATE/feature_request.md1-21

存储库结构

了解仓库结构对于任何可能最终为该项目做出贡献的人来说都很重要

要同时获取 drawio-desktop 仓库和 draw.io 子模块,您需要递归克隆

git clone --recursive https://github.com/jgraph/drawio-desktop.git

来源:README.md29-31

行为准则

所有贡献者都必须遵守该项目的行为准则,该准则提倡

  • 热情包容的语言
  • 互相尊重的行为
  • 建设性的批评
  • 以社区为中心的决策
  • 对社区成员的同理心

行为准则还禁止

  • 性化的语言或图像
  • 捣乱或贬低性评论
  • 骚扰
  • 发布他人私人信息
  • 不当行为
  • 不尊重他人时间
  • 不耐烦或粗鲁
  • 强迫开发人员进行修复
  • 表现出不恰当的权利感

来源:CODE_OF_CONDUCT.md1-47

问题模板

该项目提供了 bug 报告和功能请求的模板,以确保包含所有必要的信息

模板类型所需信息关键组件
Bug 报告描述、重现步骤、预期行为、版本信息同意行为准则,确认搜索重复项
功能请求问题描述、建议的解决方案、考虑过的替代方案同意行为准则,确认搜索重复项

来源:.github/ISSUE_TEMPLATE/bug_report.md1-40 .github/ISSUE_TEMPLATE/feature_request.md1-21

开发工作流

对于可能接受贡献的罕见情况,或对于项目中工作的维护者,基本流程是

  1. 设置开发环境(参见 设置
  2. 对代码库进行更改
  3. 进行彻底测试以确保没有回归
  4. 创建拉取请求(如果适用)

来源:README.md26-49

支持

drawio-desktop 项目的支持基于合理的业务限制提供,不附带合同义务。所有支持均通过 GitHub 仓库提供,非付费用户没有私人支持票务服务。

请注意,购买 draw.io for Confluence 或 Jira 不代表您有权获得 draw.io desktop 的商业支持,除非您拥有 draw.io for Confluence Cloud 的付费高级(高级)版本。

来源:README.md19-24