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