# docs

**Repository Path**: HiSpark/docs

## Basic Information

- **Project Name**: docs
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: CC-BY-4.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2024-08-23
- **Last Updated**: 2025-07-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# docs

## 介绍

docs代码仓为HiSpark社区文档仓库。此仓库主要提供社区规范及代码文件模板供大家学习使用。

## 社区仓库介绍


| 仓库名                                                       | 描述                                    | 支持渠道                                                     |
| ------------------------------------------------------------ | --------------------------------------- | ------------------------------------------------------------ |
| **[fbb_ws63](https://gitee.com/HiSpark/fbb_ws63)**           | fbb_ws63代码仓为支持ws63系列解决方案SDK | [星闪解决方案](https://developers.hisilicon.com/forum/0133146886267870001) |
| **[open_mcu](https://gitee.com/HiSpark/open_mcu)**           | open_mcu代码仓为支持306x解决方案SDK。   | [MCU解决方案](https://developers.hisilicon.com/forum/0101108112079179002) |
| **[hi3861_hdu_iot_application](https://gitee.com/HiSpark/hi3861_hdu_iot_application)** | <物联网技术及应用>课程代码仓。          | [Wi-Fi IoT解决方案](https://developers.hisilicon.com/forum/0102108098553062001) |

## 社区用户行为准则

HiSpark社区遵守开源社区[《贡献者公约》](https://contributor-covenant.org/)V1.4中规定的行为守则，请参考[V1.4版本](https://www.contributor-covenant.org/zh-cn/version/1/4/code-of-conduct.html)，如需举报侮辱、骚扰或其他不可接受的行为，您可以在[开发者论坛](https://developer.hisilicon.com/forum/all)联系版主处理，详细内容参考[行为准则](contribute/行为准则.md)。

## 社区参与贡献

1.案例开发完成，需要提供配套文档，请先获取模板[Demo配套模板](template/Demo配套模板.md)，根据模板完善内容。

2.案例、文档需要提供对应许可证及版权头，详情请参考：[许可证与版权规范](contribute/许可证与版权规范.md)

3.如果提供的案例涉及第三方开源软件，请参考[社区第三方开源软件引入指导](contribute/社区第三方开源软件引入指导.md)补充相关内容，如果不涉及选择跳过，直接参考步骤4。

4.案例、文档已经准备完成，请参考[社区参与贡献指南贡献流程章节](contribute/社区参与贡献指南.md)提交PR。

5.PR提交完成，在扫描过程中遇到Codecheck等问题，请参考[社区参与贡献指南贡献代码要求章节](contribute/C语言编程规范.md)进行修改。

6.如果扫描遇到开源合规告警（sca_scan），请参考[FossLicense开源合规告警澄清规范](contribute/FossLicense开源合规告警澄清规范.md)进行修改。

7.如果扫描遇到工具问题导致的误报或者规范例外场景可以申请屏蔽，详情请参考[社区代码合入要求屏蔽指导章节](contribute/社区代码合入要求.md)。

8.如果扫描通过，仓库管理者会合入到主干

## 社区问题支持

- 在开发者论坛提问或者寻找其他帖子问题，详情请参考[支持渠道](https://developers.hisilicon.com/forum/all)。

## 社区整体流程规范

如果需要在HiSpark上架代码、开发板、文档等，整体流程及规范请参考[社区代码仓运作规范](contribute/社区代码仓运作规范.md)。

## 社区硬件上架规范

如果需要上架硬件开发板，需要提供硬件原理图、配套文档、购买链接、技术支持，详情请参考[社区开发板上架规范](contribute/社区开发板上架规范.md)。

## 社区文档上架规范。

如果需要上架资料文档，需要根据模板完善内容，请参考[开源社区文档写作规范](contribute/开源社区文档写作规范.md)。

## 社区代码上架规范

如果需要上架代码，根据不同语言选择不同的规范，参考如下：

- [C语言编程规范](contribute/C语言编程规范.md)
- [C++语言编程规范](contribute/C++语言编程规范.md)
- [Python语言编程规范](contribute/Python语言编程规范.md)

## 社区漏洞治理

主要包括漏洞处理策略、漏洞处理流程、漏洞公告，请参考[漏洞治理](security/README.md)