贡献指南#
感谢您对参与本项目作出贡献的兴趣。无论是错误报告、新功能、更正还是补充文档,我们都非常珍视社区的反馈和贡献。
在提交任何问题或拉取请求之前,请仔细阅读本文档,以确保我们获得所有必要的信息来有效回应您的错误报告或贡献。
问题和讨论主题#
可以使用 discussions 提出问题和讨论主题。
报告错误/功能请求#
欢迎您使用 GitHub issue 跟踪器报告错误或建议功能。
提交问题时,请检查现有的开放或最近关闭的问题,以确保没有人报告过同样的问题。请尽可能多地包含信息。以下详细信息非常有用:
可重现的测试用例或一系列步骤
正在使用的代码版本
与错误相关的任何修改
您的环境或部署中的任何异常情况
通过拉取请求贡献#
非常感谢通过拉取请求进行的贡献。在向我们发送拉取请求之前,请确保:
您正在针对
dev
分支上的最新代码进行开发。您检查现有的开放拉取请求和最近合并的拉取请求,以确保没有其他人已经解决了这个问题。
您就任何重要工作开启一个问题进行讨论——我们不希望浪费您的时间。
要向我们发送拉取请求,请:
Fork(派生)该仓库。
修改源代码;请专注于您贡献的具体更改。如果您同时重新格式化所有代码,我们将难以专注于您的更改。
通过执行
pytest
确保本地测试通过。使用清晰的提交信息提交到您的 fork。
向我们发送拉取请求,并回答拉取请求界面中的所有默认问题。
注意拉取请求中报告的任何自动化 CI 失败,并参与讨论。
寻找可以贡献的工作#
查看现有问题是寻找可以贡献内容的好方法:带有“good first issue”或“help wanted”标签的问题是很适合入门的地方。
行为准则#
本项目采用了亚马逊开源行为准则。更多信息请参阅行为准则常见问题或联系opensource-codeofconduct@amazon.com 提出其他问题或意见。