贡献指南【免费下载链接】hcommHCOMMHuawei Communication是HCCL的通信基础库提供通信域以及通信资源的管理能力。项目地址: https://gitcode.com/cann/hcomm感谢您对HCCL的关注本项目欢迎广大开发者体验并参与贡献。在参与社区贡献之前请参见cann-community了解行为准则进行 CLA 协议签署了解源码仓的贡献流程。期望的贡献问题修复修复自己发现的或在Issue列表中的Bug比如代码中的逻辑错误、内存泄漏或崩溃等问题社区任务领取HCCL社区公布的任务性能优化针对特定算子或特定架构的性能优化新功能支持增加平台功能、新算子或新业务场景的支持文档优化改进文档、注释或使用用例。预备知识编码规范请遵从CANN 社区编码规范。PR规范提交 PR 时请按照 PR 模板仔细填写本次 PR 的业务背景、目的、方案等信息所有PR都必须关联Issue请在PR描述中引用对应的Issue编号使用 Git 提交代码前请参考 pre-commit工具使用指导以保持代码风格一致且符合合规规范。若您的修改不是简单的 bug 修复而是涉及到新增特性、新增接口、新增配置参数或者修改代码流程等请务必先通过 Issue 进行方案讨论以避免您的代码被拒绝合入。若您不确定本次修改是否可被归为简单的 bug 修复亦可通过提交 Issue 进行方案讨论。贡献流程贡献可以分为两类简单问题处理Bug修复、简单代码修改、文档修改等新功能或新特性增加新功能、新特性、新接口或者支持新业务场景的贡献。整体流程简单问题处理查询并认领Issue现在Issue列表中查询该问题是否有对应的Issue如有对应Issue直接认领该Issue如无对应Issue创建新的Issue并认领。修改代码并提交PR需要满足编码规范与PR规范确保包含触发Bug的回归测试。代码评审与合入负责对应模块或组件的Committer检视代码并反馈检视意见请根据意见修改没有问题后添加/lgtm和/approve标签并合入。增加新功能或新特性提交Requirement类型Issue在代码仓提交Requirement类型的Issue详细描述使用场景、业务价值、大致技术方案在社区发起讨论SIG组决策是否接纳该需求如果接纳添加accepted标签。系统方案设计需求被接纳后设计详细的系统方案在docs/rfcs目录下创建markdown格式的RFC文件并按RFC模板撰写系统方案提交PR。系统方案评审详细设计方案通过包含RFC的PR进行评审过程中请针对评审意见进行方案修改RFC合入所有Maintainer对方案均无异议后由Maintainer添加/lgtm和/approve标签合入合入的RFC方案作为后续代码实施的合约代码实现需要遵循RFC方案。软件实现按照RFC方案实现代码并提交PR必须包含对应的测试代码包含单元测试与系统测试。代码评审与合入负责对应模块或组件的Committer检视代码并反馈检视意见请根据意见修改没有问题后添加/lgtm和/approve标签并合入。争议处理存在争议的Issue、PR或RFC可以在SIG工作会议上申报议题由SIG组决策。本文档由社区维护如有变更建议请在Issue中提出。【免费下载链接】hcommHCOMMHuawei Communication是HCCL的通信基础库提供通信域以及通信资源的管理能力。项目地址: https://gitcode.com/cann/hcomm创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考