CONTRIBUTING.md

贡献指南

感谢您对 Paper Reading Framework 项目的关注！我们欢迎各种形式的贡献。

如何贡献

报告 Bug

如果您发现了 bug，请：

1. 检查 Issues 确认该 bug 尚未被报告
2. 使用 Bug Report 模板 创建新 issue
3. 提供详细的复现步骤和环境信息

提出新功能

如果您有功能建议，请：

1. 检查 Issues 确认该功能尚未被提出
2. 使用 Feature Request 模板 创建新 issue
3. 详细描述功能的使用场景和预期效果

提交代码

1. Fork 本仓库
2. 创建功能分支 (git checkout -b feature/AmazingFeature)
3. 提交更改 (git commit -m 'feat: Add some AmazingFeature')
4. 推送到分支 (git push origin feature/AmazingFeature)
5. 创建 Pull Request

代码规范

• 遵循 PEP 8 Python 代码规范
• 使用 4 个空格缩进
• 行长度限制 120 字符
• 添加适当的注释和文档字符串
• 使用类型提示（Type Hints）

提交信息规范

使用 Conventional Commits 规范：

• feat: 新功能
• fix: Bug 修复
• docs: 文档更新
• style: 代码格式（不影响功能）
• refactor: 代码重构
• test: 测试相关
• chore: 构建/工具相关

测试

提交代码前请确保：

• 所有测试通过
• 新功能包含测试用例
• 代码格式正确

问题反馈

如有任何问题，请通过以下方式联系：

• 创建 Issue
• 在 Discussions 中讨论

感谢您的贡献！🎉