CONTRIBUTING.md

Contributing to PyEdmine

感谢你对 PyEdmine 的关注与支持！我们欢迎来自社区的任何形式贡献，无论是报告问题、提出建议、提交代码改进，还是分享训练成果。

开始之前

请先阅读我们的 README 和 项目文档，了解项目的目标、结构与核心使用流程。

反馈 Bug / 建议

如发现 Bug 或有改进建议，请通过 GitHub Issue 提出。
在 issue 中，请包含以下信息（越详细越好）：

• 使用的 PyEdmine 版本（例如：v1.0.0）
• 问题描述与复现步骤
• 错误信息、日志或截图等

推荐论文

欢迎推荐教育数据挖掘相关论文加入本项目支持模型中。
请将推荐内容发布至 功能建议收集贴 | Feature Request Thread。

贡献代码

你可以通过以下两种方式提交代码贡献：

直接提交 Pull Request

适用于较小修复或无潜在冲突的更新，例如：

• 文档更新
• 简单 bug 修复
• 小功能增强，不影响现有功能

请确保 PR 包含：

• 清晰的描述与修改目的
• 适当的单元测试（如适用）
• 格式整洁、符合项目编码规范

先讨论再贡献

若你的更改范围较大（例如新增模型、修改框架逻辑），建议你：

1. 通过 Issue 描述你的计划和设计思路
2. 与维护者讨论后达成共识
3. 再提交 PR，便于评审与协作

提供训练好的模型权重

如果你希望分享训练好的模型权重，请发邮件至：18800118477@163.com

附件中请包含：

• 模型权重文件或下载链接
• 对应的训练脚本或说明文档
• 相关参数配置与依赖说明

我们将审核后考虑集成这些权重。

若你提交的是 PyEdmine 尚未实现的新模型，请先通过 Pull Request 提交实现代码，然后再发送邮件通知。

代码风格与测试

请遵循项目中的代码风格。最佳实践包括但不限于：

• 保持一致的缩进与代码结构
• 添加或更新文档注释与 README 内容

社区行为准则

• 对他人友好与尊重
• 清晰表达问题和想法
• 欢迎提问与协助他人

---