贡献指南【免费下载链接】metadefAscend Metadata Definition项目地址: https://gitcode.com/cann/metadef本项目欢迎广大开发者体验并参与贡献在参与社区贡献之前。请参见cann-community了解行为准则进行CLA协议签署了解源码仓的贡献流程该仓详细介绍了如何参与CANN开源项目的贡献的前置条件包括但不限于如何提交PRgitcode工作流流水线触发命令交互参考代码检视其他注意事项 详情可以参考cann-community。除此之外开发者准备本地代码与提交PR时需要重点关注如下几点提交PR时请按照PR模板仔细填写本次PR的业务背景、目的、方案等信息。使用git进行代码提交前可以参考pre-commit工具使用说明来使您的代码提交更合规高效。若您的修改不是简单的bug修复而是涉及到新增特性、新增接口、新增配置参数或者修改代码流程等请务必先通过Issue进行方案讨论以避免您的代码被拒绝合入。若您不确定本次修改是否可被归为“简单的bug修复”亦可通过提交Issue进行方案讨论。提交pr时请确保您的代码符合项目的代码规范具体参考google的开源代码规范包括但不限于代码格式化注释规范变量命名规范函数命名规范类命名规范接口命名规范配置参数命名规范代码流程规范提交pr时如果存在多个无效commit建议您在提交pr前先进行rebase操作合并多个commit为一个以保持代码的简洁性和可读性具体参考git rebase同时commit message也需要符合项目的代码规范能够清晰地描述本次变更的意图和内容格式为类型: 简短描述。 例如:|类型|说明|示例| |--|--|--| |feat|新功能|feat: 添加用户注册功能| |fix|修复 bug|fix: 修复登录态过期问题| |docs|文档更新|docs: 更新 API 使用说明| |style|代码格式调整不影响逻辑|style: 调整代码缩进| |refactor|重构非功能新增/修复|refactor: 优化用户服务类结构| |perf|性能优化|perf: 减少数据库查询次数| |test|测试相关|test: 添加登录功能单元测试| |chore|构建/工具链变更|chore: 更新 webpack 配置| |ci|CI 配置相关|ci: 添加自动化测试流程|开发者贡献场景主要包括Bug修复如果您在本项目中发现了某些Bug希望对其进行修复欢迎您新建Issue进行反馈和跟踪处理。您可以按照提交Issue/处理Issue任务指引新建Bug-Report|缺陷反馈类Issue对Bug进行描述然后在评论框中输入“/assign”或“/assign yourself”将该Issue分配给您进行处理。贡献新功能如果您在本项目中发现了某些功能缺失希望对其进行新增欢迎您新建Issue进行反馈和跟踪处理。您可以按照提交Issue/处理Issue任务指引新建Requirement|需求建议类Issue对新增功能进行说明并提供您的设计方案 然后在评论框中输入“/assign”或“/assign yourself”将该Issue分配给您进行跟踪实现。文档纠错如果您在本项目中发现某些文档描述错误欢迎您新建Issue进行反馈和修复。您可以按照提交Issue/处理Issue任务指引新建Documentation|文档反馈类Issue指出对应文档的问题然后在评论框中输入“/assign”或“/assign yourself”将该Issue分配给您纠正对应文档描述。帮助解决他人Issue如果社区中他人遇到的问题您有合适的解决方法欢迎您在Issue中发表评论交流帮助他人解决问题和痛点共同优化易用性。如果对应Issue需要进行代码修改您可以在Issue评论框中输入“/assign”或“/assign yourself”将该Issue分配给您跟踪协助解决问题。【免费下载链接】metadefAscend Metadata Definition项目地址: https://gitcode.com/cann/metadef创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考