为aeon做贡献¶
aeon 是一个社区驱动的项目,非常欢迎贡献。我们重视各种形式的贡献,不仅仅是代码。改进文档、报告错误、承担沟通或行为准则责任都是超越代码的有价值贡献的例子,这些贡献帮助使 aeon 成为一个优秀的包。
请考虑在分配给自己之前,您是否能够处理和解决问题或拉取请求。如果问题需要编辑Python代码,您应该有一些Python经验并能够运行测试。如果问题涉及机器学习算法的具体细节,则需要一些相关的机器学习知识。虽然我们希望鼓励新的贡献者,但需要对某些问题有一定的基础知识才能做出有意义的贡献。ChatGPT不能替代这些知识。
来自未知贡献者的拉取请求,如果未尝试解决所涉及的问题,完全无视拉取请求模板,或包含低质量的AI生成输出,可能会在没有审查的情况下被关闭。
接下来我们将简要概述如何为aeon做出贡献。为开源项目做出贡献需要一些主动性,起初可能会让人感到畏惧,但社区成员会在这里提供帮助并回答问题。如果你遇到困难,请不要犹豫与我们交流或提出问题。
首次贡献者或开始定期贡献的推荐步骤:
在Slack的
introductions或contributors频道中打个招呼,并提及你感兴趣贡献的地方。获取开发设置,请参阅开发者安装说明以创建
aeon的分支。从问题列表中选择一个
增强、文档或维护问题来完成,例如改进算法、文档字符串或测试。好的第一个问题列表可能是一个不错的起点。在你想要处理的问题上发布帖子,以便其他人知道你在处理它。首先确保该问题尚未被他人处理。查看是否有任何链接的PR,并在拉取请求列表中搜索问题编号。 要为自己分配一个问题/拉取请求,请在问题中发布一条评论,包括‘@aeon-actions-bot’、要分配的用户名和单词
assign:例如:
@aeon-actions-bot assign @MatthewMiddlehurst
在分配给自己之前,请确保您理解并有解决问题的计划。如果不确定,请随时要求澄清。如果是一个涉及多个组件的较大问题,请指明您正在处理的部分。如果您选择的问题复杂或已经有人在处理,核心开发人员可能会建议一个不同的问题。
创建一个拉取请求(PR),包含你从你的分支所做的更改。如需帮助,请参阅GitHub文档或在Slack中询问。遵循PR模板、模板注释和检查清单。请确保包含适当的标题标签。不要仅仅删除PR模板文本。
核心开发者将审查您的PR并可能提供反馈,您可以随后处理这些反馈。如果您对任何反馈不确定,请请求澄清。请耐心等待,因为核心开发者是志愿者,可能忙于其他任务或包之外的生活。在缓慢期间,可能需要一段时间才能获得审查,因此请不要急于@开发者或反复请求审查。考虑将PR作为草稿打开,直到准备好进行审查并通过测试。
一旦您的PR被批准,它将被合并到
aeon仓库中。感谢您的贡献!请确保您被包含在贡献者列表中。
关于通过GitHub为aeon做出贡献的进一步指导可以在开发者指南中找到。在贡献之前不需要阅读这里的所有内容,但如果你的问题与特定主题相关,例如文档或测试,你可能会发现它很有用。
如果您打算的贡献方式不符合上述步骤,请通过Slack与我们联系进行讨论。虽然GitHub贡献是最常见的,但它并不是唯一为aeon做出贡献的方式。
致谢贡献¶
我们遵循所有贡献者规范并认可各种类型的贡献。看看我们过去和现在的贡献者!
如果您是新贡献者,请确保我们将您添加到我们的贡献者列表中。所有贡献都记录在.all-contributorsrc中。或者,您可以使用@all-contributors机器人来为您完成此操作。如果贡献包含在PR中,请在PR合并后仅@机器人。相关标签列表可以在这里找到。
进一步阅读¶
有关如何为aeon做出贡献的更多信息,请参阅以下页面。
开发者指南
为aeon开发者提供一系列主题的指导。
打开问题
关于aeon中的问题和报告错误的指南。
Mentoring and Projects
aeon 项目和指导机会。