贡献指南#

感谢您对我们项目的关注。不论是错误报告、新功能、修正还是额外的文档,我们非常重视来自社区的反馈和贡献。

在提交任何问题或请求之前,请仔细阅读本文档,以确保我们拥有有效响应您的错误报告或贡献所需的所有必要信息。

问题和讨论主题#

可以通过discussions提出问题和讨论主题。

报告错误/功能请求#

我们欢迎您使用 GitHub issue tracker 来报告错误或建议功能。

在提交问题时,请检查 现有的开放最近关闭的 问题,以确保没有其他人已经报告了该问题。请尽量提供尽可能多的信息。这些细节非常有用:

  • 一个可重复的测试案例或一系列步骤

  • 正在使用的代码版本

  • 与该 bug 相关的任何修改

  • 您的环境或部署有什么异常吗

通过拉取请求贡献#

通过拉取请求的贡献非常感谢。在发送拉取请求之前,请确保:

  1. 您正在处理dev分支上的最新源代码。

  2. 您检查现有的开放的和最近合并的拉取请求,以确保其他人已经解决了该问题。

  3. 您打开一个问题以讨论任何重大工作 - 我们不希望您的时间被浪费。

请向我们发送拉取请求,请:

  1. 克隆该仓库。

  2. 修改源代码;请专注于您所做的具体更改。如果您还重新格式化了所有代码,我们将很难关注您的更改。

  3. 通过执行 pytest 确保本地测试通过。

  4. 使用清晰的提交信息提交到您的分支。

  5. 给我们发送一个拉取请求,在拉取请求界面回答任何默认问题。

  6. 注意在拉取请求中报告的任何自动化CI失败,并保持参与讨论。

GitHub 提供了有关 分叉一个代码库创建一个拉取请求 的额外文档。

开发环境设置#

请参考文档以了解如何设置您的开发环境。

寻找工作的贡献#

查看现有问题是找到可以贡献内容的好方法:带有 ‘good first issue’‘help wanted’ 标签的问题是一个很好的起点。

行为准则#

本项目已经采用了Amazon开源行为准则。有关更多信息,请参见行为准则常见问题解答或联系opensource-codeofconduct@amazon.com,如有任何其他问题或意见。

安全问题通知#

如果您在此项目中发现潜在的安全问题,请通过我们的 漏洞报告页面 通知 AWS/Amazon 安全团队。请务必 不要 创建公开的 GitHub 问题。

许可#

请查看LICENSE文件以获取我们项目的许可信息。我们将要求您确认您贡献的许可。

我们可能会要求您签署贡献者许可协议 (CLA)以进行更大的更改。