CONTRIBUTING.md

贡献指南

感谢你对 TG-Shegong 的关注！在提交贡献之前，请阅读以下指南。

行为准则

• 尊重所有贡献者
• 建设性的代码审查
• 不提交任何真实凭据、个人数据或会话文件

如何贡献

提交 Bug 报告

1. 在 Issues 中搜索是否已有相同问题
2. 使用清晰的标题描述问题
3. 提供复现步骤：
   • 运行环境（Python 版本、操作系统）
   • 配置信息（脱敏后的 .env，不含真实凭据）
   • 错误日志/截图
   • 预期行为 vs 实际行为

提交功能请求

1. 描述你需要的功能
2. 说明使用场景
3. 如果可能，描述实现思路

提交 Pull Request

1. Fork 本仓库
2. 创建你的功能分支：git checkout -b feature/my-feature
3. 提交更改：git commit -m 'feat: add my feature'
4. 推送到分支：git push origin feature/my-feature
5. 创建 Pull Request

PR 规范：

• 一个 PR 只做一件事
• 确保修改后能正常运行
• 新功能需附带基本测试
• 遵循项目现有代码风格
• 更新相关文档

开发环境设置

# 克隆
git clone https://github.com/yourusername/tg-shegong.git
cd tg-shegong

# 虚拟环境
python -m venv venv
source venv/bin/activate

# 安装依赖
pip install -r requirements.txt

# 运行测试
pytest tests/ -v

# 运行（需要配置 .env）
python -m src.main

代码风格

• Python 3.10+ 语法
• 4 空格缩进
• 类型注解优先
• 函数/类使用 docstring
• 异步优先（async/await）

提交信息格式

采用约定式提交：

feat: 新功能描述
fix: 修复描述
docs: 文档更新
refactor: 重构描述
test: 测试相关
chore: 构建/工具变动

安全检查清单

提交代码前请确认：

• 没有硬编码任何 API 密钥、密码或 Token
• 没有包含 .env、*.session、*.db 文件
• 没有包含个人 Telegram ID 或手机号
• 配置文件使用环境变量或示例模板

许可证

贡献的代码将在 MIT 许可证下发布。