Star0

Star0

cann-robotdocs: update contributing and guide documentation

d5d8e4f7创建于 8月6日历史提交

文件	最后提交记录	最后更新时间
README.md	新增代码贡献规范文档 Co-authored-by: wuyang_hw<wuyang74@hisilicon.com> # message auto-generated for no-merge-commit merge: !2313 merge guidelines into master 新增代码贡献规范文档 Created-by: wuyang_hw Commit-by: wuyang_hw Merged-by: cann-robot Description: ## 描述在 `docs/contributing/` 下新增贡献规范文档，统一编码风格、API 设计、目录结构、测试编写等约定。同步更新 `CONTRIBUTING.md` 添加规范索引。 \| 文档 \| 内容 \| \|------\|------\| \| `code-style.md` \| 命名、header guard、include、namespace、宏、constexpr、格式化 \| \| `api-design.md` \| 三种 API 对比、模板参数、`__aicore__`、Tiling 接口、弃用标注 \| \| `directory-structure.md` \| include/↔impl/ 映射、文件后缀、架构目录、新增 API 清单 \| \| `testing.md` \| 测试框架、UT 编写模板、Header Checker、覆盖率要求 \| \| `README.md` \| 规范索引与快速导航 \| ## 关联的Issue NA ## 测试纯文档变更，内部链接已校验。 ## 文档更新同步更新 `CONTRIBUTING.md`。 ## 类型标签 - [ ] 🐛 fix - [ ] ✨ feat - [ ] ⚡ perf - [ ] ♻️ refactor - [ ] 🧪 test - [x] 📝 docs - [ ] 🔧 ci - [ ] ↩️ revert - [ ] 🧹 chore See merge request: cann/asc-devkit!2313	1 个月前
api-design.md	docs: update tiling types in contributing guides Co-authored-by: kyzyc<zhuyuchen10@huawei.com> # message auto-generated for no-merge-commit merge: !4799 merge docs/fix-tiling-type-alias-contributing into master docs: update tiling types in contributing guides Created-by: kyzyc Commit-by: kyzyc Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> 新增的贡献指南将 ge::Shape、ge::DataType 修改为整改后的 AscendC::TensorShape、AscendC::TensorDataType ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #xxx--> ## 测试 <!--描述进行了哪些测试来验证你的改动。包括但不限于二级冒烟、算子泛化等。--> ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> ## 类型标签 <!-- [x] 表示选中 --> - [ ] 🐛 fix: Bug 修复 - [ ] ✨ feat: 新功能 - [ ] ⚡ perf: 性能优化 - [ ] ♻️ refactor: 代码重构 - [ ] 🧪 test: 新增或修改测试 - [x] 📝 docs: 文档更新 - [ ] 🔧 ci: CI/CD 配置修改 - [ ] ↩️ revert: 回退 - [ ] 🧹 chore: 其他，请具体描述 See merge request: cann/asc-devkit!4799	1 个月前
code-style.md	新增代码贡献规范文档 Co-authored-by: wuyang_hw<wuyang74@hisilicon.com> # message auto-generated for no-merge-commit merge: !2313 merge guidelines into master 新增代码贡献规范文档 Created-by: wuyang_hw Commit-by: wuyang_hw Merged-by: cann-robot Description: ## 描述在 `docs/contributing/` 下新增贡献规范文档，统一编码风格、API 设计、目录结构、测试编写等约定。同步更新 `CONTRIBUTING.md` 添加规范索引。 \| 文档 \| 内容 \| \|------\|------\| \| `code-style.md` \| 命名、header guard、include、namespace、宏、constexpr、格式化 \| \| `api-design.md` \| 三种 API 对比、模板参数、`__aicore__`、Tiling 接口、弃用标注 \| \| `directory-structure.md` \| include/↔impl/ 映射、文件后缀、架构目录、新增 API 清单 \| \| `testing.md` \| 测试框架、UT 编写模板、Header Checker、覆盖率要求 \| \| `README.md` \| 规范索引与快速导航 \| ## 关联的Issue NA ## 测试纯文档变更，内部链接已校验。 ## 文档更新同步更新 `CONTRIBUTING.md`。 ## 类型标签 - [ ] 🐛 fix - [ ] ✨ feat - [ ] ⚡ perf - [ ] ♻️ refactor - [ ] 🧪 test - [x] 📝 docs - [ ] 🔧 ci - [ ] ↩️ revert - [ ] 🧹 chore See merge request: cann/asc-devkit!2313	1 个月前
directory-structure.md	docs: update contributing and guide documentation Co-authored-by: ai_xin<aixin2@hisilicon.com> # message auto-generated for no-merge-commit merge: !4903 merge master into master docs: update contributing and guide documentation Created-by: ai_xin Commit-by: ai_xin Merged-by: cann-robot Description: ## 描述优化文档内容 ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #xxx--> ## 测试 <!--描述进行了哪些测试来验证你的改动。包括但不限于二级冒烟、算子泛化等。--> ## 文档更新更新了docs下相关的md文件。 ## 类型标签 <!-- [x] 表示选中 --> - [ ] 🐛 fix: Bug 修复 - [ ] ✨ feat: 新功能 - [ ] ⚡ perf: 性能优化 - [ ] ♻️ refactor: 代码重构 - [ ] 🧪 test: 新增或修改测试 - [x] 📝 docs: 文档更新 - [ ] 🔧 ci: CI/CD 配置修改 - [ ] ↩️ revert: 回退 - [ ] 🧹 chore: 其他，请具体描述 See merge request: cann/asc-devkit!4903	1 个月前
testing.md	docs: update tiling types in contributing guides Co-authored-by: kyzyc<zhuyuchen10@huawei.com> # message auto-generated for no-merge-commit merge: !4799 merge docs/fix-tiling-type-alias-contributing into master docs: update tiling types in contributing guides Created-by: kyzyc Commit-by: kyzyc Merged-by: cann-robot Description: ## 描述 <!--在这里详细描述你的改动，包括改动的原因和所采取的方法。--> 新增的贡献指南将 ge::Shape、ge::DataType 修改为整改后的 AscendC::TensorShape、AscendC::TensorDataType ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #xxx--> ## 测试 <!--描述进行了哪些测试来验证你的改动。包括但不限于二级冒烟、算子泛化等。--> ## 文档更新 <!--如果这个PR包含文档的更新，请在这里指出。例如：更新了README.md文件。--> ## 类型标签 <!-- [x] 表示选中 --> - [ ] 🐛 fix: Bug 修复 - [ ] ✨ feat: 新功能 - [ ] ⚡ perf: 性能优化 - [ ] ♻️ refactor: 代码重构 - [ ] 🧪 test: 新增或修改测试 - [x] 📝 docs: 文档更新 - [ ] 🔧 ci: CI/CD 配置修改 - [ ] ↩️ revert: 回退 - [ ] 🧹 chore: 其他，请具体描述 See merge request: cann/asc-devkit!4799	1 个月前

AscendC Code Contribution Standards

Code Style

code-style.md — C++ code style: naming, header guards, include, namespace, macros, constexpr, formatting, code comment standards, deprecation annotation

Interface Design

api-design.md — API interface design conventions: template parameters, __aicore__, Tiling interfaces

Directory and Files

directory-structure.md — Directory structure, file naming, architecture directories, new API operation checklist

Testing

testing.md — Testing framework, file naming, UT writing, Header Checker, coverage requirements

CONTRIBUTING_en.md — Contribution process
asc_adv_api_contributing.md — High-level API development process
asc_basic_api_contributing.md — Basic API development process
asc_c_api_contributing.md — C API development process
asc_doc_contributing.md — Documentation contribution process