感谢你对 Telegram Search 项目感兴趣!本文档提供了参与项目开发的指南和说明。
- 保持友善和包容
- 专注于建设性的反馈
- 遵循项目的代码规范
- 帮助他人学习和成长
- Fork 本仓库
- 为你的功能或修复创建新分支
- 进行修改
- 提交 Pull Request
请参考 开发指南 来设置你的开发环境。
- 编写清晰、有文档说明的代码
- 严格遵循 TypeScript 类型系统
- 为新功能添加测试
- 及时更新相关文档
使用约定式提交格式:
- feat: 新功能
- fix: 错误修复
- docs: 文档变更
- style: 代码格式修改
- refactor: 代码重构
- test: 测试更新
- chore: 构建过程或辅助工具变动
示例:
feat(core): 添加视频消息向量嵌入支持
- 将你的 fork 更新到最新的主分支
- 创建功能分支
- 进行修改
- 运行测试和代码检查
- 提交 PR 并附上清晰的描述
- 响应审查意见
- 为新功能编写单元测试
- 确保所有测试在本地通过
- 必要时添加集成测试
- 测试边界情况
提交 bug 报告时,请包含:
- 清晰的问题描述
- 复现步骤
- 预期行为与实际行为的对比
- 系统环境信息
- 相关日志或截图
提出功能建议时,请:
- 解释使用场景
- 描述预期行为
- 尽可能提供示例
- 考虑实现复杂度
帮助改进文档:
- 修正错别字和错误
- 补充缺失信息
- 提高文档清晰度
- 添加示例说明
欢迎:
- 在 Issues 中提出问题
- 加入我们的讨论群组
- 联系项目维护者
感谢你的贡献!🎉