指南
以下是所有类型贡献时需要注意的一些事项:
- 遵循 "分叉和拉取请求" 工作流程。
- 在打开拉取请求时填写已检查的拉取请求模板。注意相关问题并标记相关维护者。
- 在请求审查之前,确保您的 PR 通过格式化、代码检查和测试检查。
- 如果您希望对当前进展进行评论或反馈,请打开一个问题或讨论并标记维护者。
- 请参阅 测试 和 格式化和代码检查 部分,了解如何在本地运行这些检查。
- 向后兼容性至关重要。您的更改不得破坏现有功能,除非是关键的错误和安全修复。
- 在打开新的拉取请求之前,请查找已打开的重复 PR 或问题。
- 尽量保持范围尽可能独立。一般来说,您的更改不应同时影响多个包。
修复
我们鼓励并感谢修复。我们要求您:
- 详细解释该错误,以便维护者能够重现它。
- 如果存在相关问题,请链接到它。前缀加上
Fixes
,以便在合并 PR 时自动关闭该问题。 - 尽可能避免破坏性 更改。
- 包含在没有修复时会失败的单元测试。
如果您遇到错误并不知道如何修复,我们要求您为此打开一个问题,详细描述您遇到错误的环境。
新特性
我们旨在对新特性保持高标准。我们通常不接受来自外部贡献者的新核心抽象、基础设施更改、依赖项更改, 或没有现有 GitHub 讨论或问题的新的代理/链,这些讨论或问题表明对它们的迫切需求。
- 新功能必须附带文档、单元测试和(如果适用)集成测试。
- 新集成必须附带文档、单元测试和(如果适用)集成测试。
- 有关贡献新集成的更多详细信息,请参见此页面。
- 新功能不应继承或使用已弃用的方法或类。
- 我们将拒绝可能导致安全漏洞或报告的功能。
- 不要添加任何硬性依赖。集成可以添加可选依赖。