通用指南

以下是所有类型贡献需要注意的事项

• 遵循 “fork 和 pull request” 工作流。
• 在打开 pull request 时，填写已签入的 pull request 模板。注明相关问题并标记相关维护者。
• 在请求审查之前，请确保您的 PR 通过格式化、代码检查和测试。
  • 如果您希望对当前的进展获得评论或反馈，请开一个 issue 或讨论，并标记一位维护者。
  • 请参阅关于 测试 和 格式化和代码检查 的部分，了解如何在本地运行这些检查。
• 向后兼容性是关键。您的更改不得引入破坏性改动，除非是关键的 bug 修复和安全修复。
• 在开新 PR 或 issue 之前，请查找是否已存在重复的 PR 或 issue。
• 尽可能保持范围独立。通常，您的更改不应同时影响多个包。

Bug 修复

我们鼓励并感谢 bug 修复。我们要求您

• 详细解释 bug，以便维护者能够重现。
  • 如果存在相关的 issue，请链接到它。以 Fixes 作为前缀，这样当 PR 合并时，该 issue 将自动关闭。
• 如果可能，避免引入破坏性更改。
• 包含在没有 bug 修复时会失败的单元测试。

如果您遇到一个 bug 但不知道如何修复，我们请求您为此开一个 issue，详细描述您遇到 bug 的环境。

新功能

我们致力于对新功能保持高标准。我们通常不接受来自外部贡献者的新核心抽象、基础设施更改、依赖项更改或新代理/链，除非有现有的 GitHub 讨论或 issue 表明对此有迫切需求。

• 新功能必须附带文档、单元测试以及（如果适用）集成测试。
• 新集成必须附带文档、单元测试以及（如果适用）集成测试。
  • 请参阅 此页面 了解贡献新集成的更多详情。
• 新功能不应继承或使用已废弃的方法或类。
• 我们拒绝可能导致安全漏洞或报告的功能。
• 不要添加任何硬依赖项。集成可以添加可选依赖项。