Skip to content

Latest commit

 

History

History
64 lines (37 loc) · 3.19 KB

File metadata and controls

64 lines (37 loc) · 3.19 KB

Delta Comic 贡献指南

你好!我们非常高兴你为 Delta Comic 贡献代码。在提交你的代码之前,请阅读 行为准则本文件:

问题报告指南

  • 请先搜索你的问题,它可能已经被回答过,甚至已经被修复了。

  • 请确认该问题在最新发行版 Delta Comic 中也能复现。该规定也在issue模板中提及。

  • 必须清楚描述复现你遇到的问题所需的步骤。虽然我很乐意尽可能帮助用户,但如果没有清晰的复现步骤,排查问题会非常耗时,而且从长期来看并不现实。

  • 尽量使用最简洁来复现异常行为。一个好的 Bug 报告应该能隔离出具体出现异常的方法,并准确说明预期是如何被违反的。你期望这些方法做什么,而实际发生了什么差异?你隔离得越精确,我们就越能快速定位问题。

  • 如果你的问题已经解决但仍处于打开状态,请不要犹豫,直接关闭它。如果你自己找到了方案,也可以顺便告诉别人你是怎么修复的,这会对其他人有帮助。

  • 最重要的是,请耐心一些:我必须在你的请求与许多其他职责之间进行平衡: 修复其他 Bug、回答其他问题、开发新功能、编写新文档等等。问题列表并不是付费支持,我们也无法保证你的问题或要求会多快得到解决。

拉取请求指南

  • 你必须 签署你的提交

  • 在你推进 PR 的过程中,保留多个小提交也没关系——我们会让 GitHub 在合并前自动压缩它们。

  • 如果添加新功能:

    • 请提供一个令人信服的理由来添加此功能。理想情况下,你应该先开启一个建议类 issue 并获得认可后再开始实现。
  • 如果修复 Bug:

    • 如果你在解决某个特定 issue,请在 PR 标题中加入 (fix: #xxxx[,#xxx])(其中 #xxxx 是 issue 编号),这样能让发布日志更清晰,例如:fix: 修复文字显示格式 (fix #114514)
    • 在 PR 中提供该 Bug 的详细描述,或者链接到一个已有 issue。

开发指南

  • 请务必遵守样式规则。

通用设置

要配置开发环境,请确保:

  • node版本>=25
  • rustc版本>=1.94.0
  • vscode安装推荐的插件

然后,fork并clone本仓库。

开发与测试

先使用pnpm i安装依赖,然后pnpm dev就可以启动

AI 生成内容

审查一个 Pull Request 需要花费大量时间,而使用 AI 工具却很容易做出看起来合理、实际上毫无意义的 PR。

这对其他贡献者和审查者来说都不公平,因为他们要花很多时间处理这些内容,因此我们有以下规则:

  1. 在提交之前,请审查并测试所有由 LLM 生成的内容;你对它负责,不是 AI 负责。
  2. 不要使用 AI 来回复审查意见(翻译除外)。

如果你没有做到以上要求,我们会给你的 Pull Request 打上 数字泔水 标签并关闭它。