为 Ascend Deployer 贡献

感谢您考虑为 Ascend Deployer 做出贡献!我们欢迎任何形式的贡献,包括错误修复、功能增强、文档改进等,甚至只是反馈。无论您是经验丰富的开发者还是第一次参与开源项目,您的帮助都是非常宝贵的。

您可以通过多种方式支持本项目:

  • 通过Ascend Deployer社区任务池参与贡献。
  • 审查Pull Request并协助其他贡献者。
  • 传播项目:在博客文章、社交媒体上分享Ascend Deployer,或给仓库点个⭐。

参与贡献前,请先签署开放项目贡献者许可协议(CLA),提前了解《社区行为规范》

开发前,请先阅读文档 Ascend Deployer

贡献方式

Pull Request

提交PR前,请先了解《Pull Request (PR) 提交流程指南》PR最佳实践,掌握从Fork到提交、从代码审查到合并的完整PR流程,包括CI检查、标签要求和合并规范。

Issue

提交Issue前,请先了解《Issue 创建与处理指南》 ,学习如何有效创建、分类和管理Issue,包括问题报告、功能请求的规范格式。

SIG会议

可提前通过sig-MindCluster Etherpad链接进入共享文档 ,编辑申报议题,在MindCluster SIG会议日历中找到对应会议链接并按时参会。

PR最佳实践

  1. Fork仓库:在GitCode平台代码仓库右上角点击"Fork"按钮,Fork一份源代码到个人仓。

  2. 克隆到本地

    将Fork到个人仓的代码克隆到本地进行代码开发。

    git clone https://gitcode.com/<your-username>/ascend-deployer.git
    cd ascend_deployer
    
  3. 创建开发分支

    git checkout -b {new_branch_name} origin/dev
    
  4. 代码开发

    质量符合开发规范安全编程指导

  5. 开发验证

    在提交代码前,请补充测试用例并确保所有测试通过,本地执行UT:

    bash test/run_dt_tests.sh
    
  6. 执行pre-commit检查

    本地提交代码前请先执行pre-commit检查,检查指导参见pre-commit本地运行指南

  7. 提交Pull Request

    • 保持PR小规模,一次PR只解决一个问题,单个PR不超过1000行(含测试)代码变更。
    • 及时更新,定期同步上游主分支,及时响应评审意见。
    • 描述清晰,详细描述变更原因和方式,提供测试方法,添加截图或示例。
  8. 社区评审

    如果涉及patch、API接口等更新,需提交社区在SIG例会进行评审,社区定期例会与活动参见会议日历

分支/Tag命名规则

自研代码仓库

分支类型 分支名规则 示例 说明 tag名规则 tag示例
主干&开发 dev - - - -
release release/<版本号> release/v26.1.0 正式版本 <版本号>[-beta.<序号>] v26.1.0,v26.1.0-beta.1
poc poc/<基线分支>/<描述> poc/release-v26.1.0/auth-redesign 后续合入主干 poc/<基线分支>/<描述>-v<序号> poc/release-v26.1.0/auth-redesign-v1

参考