Skip to content

贡献指南 ​

准备工作 ​

  1. Fork并clone仓库
  2. 从main分支创建feature分支
  3. 安装项目依赖

开发流程 ​

  1. 遵循对应的代码规范(见本分类下各语言规范)
  2. 遵循Git提交规范(见Git提交规范)
  3. 遵循命名规范(见命名规范)
  4. 编写代码时注意可读性,避免过度抽象
  5. 新增功能必须包含测试

提交PR ​

  1. 确保CI全部通过
  2. PR标题遵循Conventional Commits格式
  3. PR描述包含:变更内容、变更原因、测试方式
  4. 保持PR尽可能小(不超过400行变更)
  5. 请求至少1位审查人

代码审查 ​

  • 审查关注:逻辑正确性、安全性、性能、代码风格、可维护性
  • 友好讨论,对事不对人
  • 审查通过后使用Squash Merge合并

Issue规范 ​

  • 报告bug请提供:环境信息、复现步骤、期望行为、实际行为、截图
  • 功能请求请说明:使用场景、期望效果
  • 使用Issue模板(如有)