Skip to content

Latest commit

 

History

History
101 lines (70 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

101 lines (70 loc) · 1.84 KB

贡献指南

感谢你对 Telegram Search 项目感兴趣!本文档提供了参与项目开发的指南和说明。

行为准则

  • 保持友善和包容
  • 专注于建设性的反馈
  • 遵循项目的代码规范
  • 帮助他人学习和成长

开始贡献

  1. Fork 本仓库
  2. 为你的功能或修复创建新分支
  3. 进行修改
  4. 提交 Pull Request

开发流程

1. 环境设置

请参考 开发指南 来设置你的开发环境。

2. 代码修改

  • 编写清晰、有文档说明的代码
  • 严格遵循 TypeScript 类型系统
  • 为新功能添加测试
  • 及时更新相关文档

3. 提交规范

使用约定式提交格式:

  • feat: 新功能
  • fix: 错误修复
  • docs: 文档变更
  • style: 代码格式修改
  • refactor: 代码重构
  • test: 测试更新
  • chore: 构建过程或辅助工具变动

示例:

feat(core): 添加视频消息向量嵌入支持

4. Pull Request 流程

  1. 将你的 fork 更新到最新的主分支
  2. 创建功能分支
  3. 进行修改
  4. 运行测试和代码检查
  5. 提交 PR 并附上清晰的描述
  6. 响应审查意见

5. 测试要求

  • 为新功能编写单元测试
  • 确保所有测试在本地通过
  • 必要时添加集成测试
  • 测试边界情况

问题报告

提交 bug 报告时,请包含:

  • 清晰的问题描述
  • 复现步骤
  • 预期行为与实际行为的对比
  • 系统环境信息
  • 相关日志或截图

功能建议

提出功能建议时,请:

  • 解释使用场景
  • 描述预期行为
  • 尽可能提供示例
  • 考虑实现复杂度

文档改进

帮助改进文档:

  • 修正错别字和错误
  • 补充缺失信息
  • 提高文档清晰度
  • 添加示例说明

有疑问?

欢迎:

  • 在 Issues 中提出问题
  • 加入我们的讨论群组
  • 联系项目维护者

感谢你的贡献!🎉