贡献指南

感谢您对 ACS Paper Crawler 的关注！我们欢迎各种形式的贡献。

如何贡献

报告问题

如果您发现 bug 或有功能建议：

  1. 在 GitHub Issues 中搜索是否已存在类似问题

  2. 如果没有，创建新issue并提供：

    • 清晰的标题和描述

    • 重现步骤（对于 bug）

    • 期望行为和实际行为

    • 系统信息（OS、Python版本等）

提交代码

  1. Fork 仓库

  2. 创建功能分支 (git checkout -b feature/AmazingFeature)

  3. 提交更改 (git commit -m 'Add some AmazingFeature')

  4. 推送到分支 (git push origin feature/AmazingFeature)

  5. 开启 Pull Request

代码规范

  • 遵循 PEP 8 代码风格

  • 添加适当的文档字符串

  • 为新功能编写测试

  • 保持代码简洁清晰

测试

运行测试:

pytest tests/

确保所有测试通过后再提交 PR。

文档

改进文档也是重要的贡献：

  • 修正拼写错误

  • 改进说明清晰度

  • 添加使用示例

  • 翻译文档

开发环境

设置开发环境:

git clone https://github.com/gxf1212/ACS_crawler.git
cd ACS_crawler
pip install -r requirements.txt
pip install -r requirements-dev.txt  # 开发依赖

行为准则

请保持友善和尊重。我们致力于为每个人提供友好的参与环境。

获取帮助

有问题？在 GitHub Discussions 中提问。

感谢您的贡献！ 🎉