CONTRIBUTING.md

贡献指南

感谢您对 BookmarkSummarizer 项目的兴趣！您的贡献对我们非常重要。

如何贡献

贡献的方式有很多，不仅限于提交代码：

1. 报告 Bug
2. 提出新功能建议
3. 改进文档
4. 分享您使用本工具的经验
5. 提交代码修复或新功能

提交 Pull Request

1. Fork 本仓库并克隆到本地
2. 创建新的分支: git checkout -b feature/your-feature-name
3. 提交您的更改: git commit -am 'Add some feature'
4. 推送到分支: git push origin feature/your-feature-name
5. 提交 Pull Request

开发环境设置

1. 确保您安装了 Python 3.6+
2. 安装依赖: pip install -r requirements.txt
3. 复制 .env.example 为 .env 并根据需要配置

代码规范

• 遵循 PEP 8 编码风格
• 添加适当的注释和文档字符串
• 确保新代码不会破坏现有功能
• 为新功能添加适当的测试

报告 Bug

报告 Bug 时，请尽可能详细地描述问题，包括：

• 复现步骤
• 期望行为
• 实际行为
• 系统环境（操作系统、Python 版本等）
• 如有可能，附上截图或错误日志

功能请求

请在提出新功能建议时，清晰描述：

• 您想要解决的问题
• 您建议的解决方案
• 可能的替代方案
• 为什么这个功能对大多数用户有用

行为准则

• 尊重所有贡献者
• 接受建设性批评
• 专注于最有利于社区的事情
• 体现同理心对待其他社区成员

许可证

通过提交代码，您同意您的贡献将在 Apache License 2.0 下授权。