Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
114 lines (82 loc) · 2.58 KB

CONTRIBUTING.md

File metadata and controls

114 lines (82 loc) · 2.58 KB

贡献指南

感谢你考虑为 CloudBase AI ToolKit 做出贡献！在提交贡献之前，请花点时间阅读以下指南。

项目安装

  1. 克隆项目
git clone https://github.com/TencentCloudBase/CloudBase-AI-ToolKit.git
cd CloudBase-AI-ToolKit
  1. 安装依赖
# 使用 npm
npm install

# 或使用 yarn
yarn install

# 或使用 pnpm
pnpm install

开发流程

  1. Fork 本仓库
  2. 创建你的特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交你的改动 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 打开一个 Pull Request

提交规范

为了自动生成 changelog，请遵循以下提交规范：

  • feat: ✨ 新功能
  • fix: 🐛 修复 bug
  • docs: 📝 文档更新
  • style: 💄 代码格式（不影响代码运行的变动）
  • refactor: ♻️ 重构（既不是新增功能，也不是修改 bug 的代码变动）
  • perf: ⚡ 性能优化
  • test: ✅ 增加测试
  • chore: 🔧 构建过程或辅助工具的变动

提交示例：

git commit -m "feat: 添加自动生成 changelog 功能"
git commit -m "fix: 修复部署失败的问题"
git commit -m "docs: 更新 README 文档"

版本管理

项目使用 standard-version 进行版本管理，支持以下版本类型：

  • 正式版本：npm run release
  • Alpha 版本：npm run release:alpha
  • Beta 版本：npm run release:beta
  • RC 版本：npm run release:rc

版本号规则：

  • 主版本号：不兼容的 API 修改
  • 次版本号：向下兼容的功能性新增
  • 修订号：向下兼容的问题修正

预发布版本号规则：

  • alpha: 内部测试版本
  • beta: 公测版本
  • rc: 候选发布版本

Changelog 生成

项目使用 conventional-changelog 自动生成 changelog：

  1. 首次生成（包含所有历史记录）：
npm run changelog:first
  1. 生成新的变更记录：
npm run changelog

生成的 changelog 将保存在 CHANGELOG.md 文件中。

代码风格

  • 遵循项目的代码风格指南
  • 确保所有测试通过

提交 Pull Request

  1. 确保你的 PR 描述清晰地说明了变更内容
  2. 如果可能，添加相关的测试用例
  3. 确保你的代码符合项目的代码风格
  4. 更新相关文档

问题反馈

如果你发现任何问题或有改进建议，请：

  1. 使用 GitHub Issues 提交问题
  2. 提供详细的问题描述和复现步骤
  3. 如果可能，提供相关的代码示例

行为准则

  • 尊重所有贡献者
  • 接受建设性的批评
  • 关注问题本身

感谢你的贡献！