贡献指南【免费下载链接】cann-learning-hubCANN 学习中心仓支持在线互动运行、边学边练提供教程、示例与优化方案一站式助力昇腾开发者快速上手。项目地址: https://gitcode.com/cann/cann-learning-hub本项目欢迎广大开发者体验并参与贡献在参与社区贡献之前。请参见cann-community了解行为准则进行CLA协议签署了解源码仓的贡献流程。开发者准备本地代码与提交PR时需要重点关注如下几点提交PR时请按照PR模板仔细填写本次PR的业务背景、目的、方案等信息。若您的修改不是简单的bug修复而是涉及到新增教程或者修改教程及代码等请务必先通过Issue进行方案讨论以避免您的代码被拒绝合入。若您不确定本次修改是否可被归为“简单的bug修复”亦可通过提交Issue进行方案讨论。开发者贡献场景主要包括反馈BUG建议特性改进文档修复问题新增教程新增教程要求感谢您参与CANN学习中心建设为CANN-LEARNING-HUB注入更多价值为了让您的贡献过程更顺畅、方案能更好地契合社区需求以下是详细的操作指引供您参考提交 RFC达成方案共识在正式开发前建议您先提交一份RFC请求评议文档通过创建ISSUE的方式提交方便与其他开发者充分交流方案细节、达成共识。RFC中辛苦您至少包含以下内容样例的背景和动机比如该教程解决了什么场景下的需求、能为其他开发者提供哪些参考价值教学大纲设计简要说明教程的章节目录设计如果是单篇教程说明各级结构设计预计完成时间方便社区了解开发进度也便于后续协同支持。提交PR完善交付内容当方案共识达成后您可以提交对应的PR并记得关联到之前的RFC。为确保课程质量PR中辛苦您至少包含以下内容jupyter课件根据设计好的教程大纲开发出的可交互实践课程实践答案教学课件中的实践题目答案课程涉及源码课程中的完整代码README文档介绍教程的背景及章节目录划分方便开发者阅读学习一些小提醒让贡献更顺利为了避免后续合入时的小波折还有几个小细节想跟您同步除了README或文档中需要的配图合入的代码里请不要包含二进制文件如果样例涉及第三方数据集的使用只需在文档中说明数据集的下载方式、使用方法即可无需直接提供数据集如果您的修改涉及公共代码非仅样例内部代码需要确保能通过CI样例的验证如果样例开发过程中涉及算子的新增或修改麻烦先将对应的算子变更合入到算子仓再推进教程合入。请检查您样例所使用的LICENSE是否合规建议使用Apache 2.0或MIT等协议并按照实际情况标注版权信息样例目录结构参考样例需要合入到contrib目录下您可以参考以下结构组织您的代码和文档样例名建议全部小写多个单词之间用下划线连接比如yolov3_inference├── contrib # 开发者贡献样例目录 | ├── turtoris1 # 您的样例名如yolov3_inference | | ├── 01_xxx # 第一个章节若只有一个章节可不创建 | | | ├── answer # answer目录存放章节实践答案 | | | ├── images # images目录存放jupyter配图 | | | ├── src # src目录存放样例代码 | | | ├── xxx.ipynb # 教程jupyter文件 | | | └── ... # 其他章节jupyter文件 | | ├── 02_xxx # 第二个章节若只有一个章节可不创建 | | ├── README.md # 教程README文档 | | └── ... # 其他必要文件如环境配置文件等 | ├── turtoris2 │ └── ...如果在贡献过程中有任何疑问随时欢迎在社区中交流再次感谢您的支持期待您的精彩教程【免费下载链接】cann-learning-hubCANN 学习中心仓支持在线互动运行、边学边练提供教程、示例与优化方案一站式助力昇腾开发者快速上手。项目地址: https://gitcode.com/cann/cann-learning-hub创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考