社区资源

加入ClearML对话​

对于功能请求或错误报告，请参阅ClearML的GitHub issues。

如果您有任何问题，请在ClearML的Slack频道上发布。

或者，在stackoverflow上使用clearml标签标记你的问题。

您可以通过[email protected]随时联系我们。

额外的 ClearML 资源​

阅读ClearML博客。

订阅ClearML的YouTube频道并查看教程、演示和讨论。

加入我们在Twitter上的@clearmlapp，了解ClearML的公告和社区讨论。

在LinkedIn上关注ClearML。

贡献指南​

首先，感谢您抽出时间做出贡献！

贡献可以以多种形式出现：

• 报告问题你遇到的问题
• 参与问题跟踪器和ClearML 社区 Slack 空间中的问题讨论
• Suggest new features or enhancements
• 实现新功能或修复未解决的问题

上面的列表主要是指导原则，而不是规则。请运用您的最佳判断，并随时在拉取请求中提出对此文档的更改。

报告问题​

通过遵循这些指南，您可以帮助维护者和社区理解您的报告，重现行为，并找到相关的报告。

在报告问题之前，请检查是否已经出现在这里。如果已经存在，请加入正在进行的讨论。

报告问题时，请尽可能包含详细信息；解释问题并包含额外细节以帮助维护者重现问题：

• 使用清晰且描述性的标题来标识问题。
• 描述重现问题的确切步骤，尽可能详细。请不要仅仅总结你所做的。确保解释你是如何做到的。
• 提供具体的环境设置。 包括 pip freeze 的输出、特定的环境变量、Python 版本以及其他相关信息。
• 提供具体示例以演示步骤。 包括文件或GitHub项目的链接，或复制/粘贴您在这些示例中使用的代码片段。
• 如果您报告任何ClearML崩溃， 请包含一个带有操作系统堆栈跟踪的崩溃报告。确保将崩溃报告添加到问题中，并将其放在代码块、文件附件中，或将其放入gist（并提供该gist的链接）。
• 描述您在按照步骤操作后观察到的行为以及该行为的确切问题。
• 解释你期望看到的行为及其原因。
• 对于WebApp（UI）问题，请包括截图和动画GIF，这些截图和GIF应重现描述的步骤并清楚地展示问题。您可以使用LICEcap在macOS和Windows上录制GIF，在Linux上使用silentcast或byzanz。

建议新功能和增强​

通过遵循这些指南，您可以帮助维护者和社区理解您的建议并找到相关的建议。

增强建议作为GitHub问题进行跟踪。在确定您的增强建议与哪个仓库相关后，请在该仓库上创建一个问题并提供以下内容：

• 一个清晰且描述性的标题，用于识别建议的问题。
• 建议增强的逐步描述，尽可能详细。
• 具体示例以展示步骤。 包括你在这些示例中使用的可复制/粘贴的代码片段，如Markdown代码块。
• 描述当前行为，并解释你期望看到的行为及其原因。
• 包含截图或动画GIF，以帮助您演示步骤或指出建议与ClearML相关的部分。您可以使用LICEcap在macOS和Windows上录制GIF，在Linux上使用silentcast或byzanz。

拉取请求​

在提交新的PR之前：

• 验证您计划合并的工作是否解决了现有的问题（如果没有，请打开一个新的问题）

• 在ClearML Slack社区中查看相关讨论 （或在#clearml-dev频道上开始您自己的讨论）

• 确保你的代码符合ClearML编码标准，通过运行：

  flake8 --max-line-length=120 --statistics --show-source --extend-ignore=E501 ./clearml*
  

在你的PR中包含：

• Reference to the problem it solves
• Briefly describe your implementation approach