帮助我们

感谢您考虑为星闪工具箱做出贡献！

如何贡献

提交固件

Fork 本仓库
在 firmwares 目录下创建你的固件目录
- 目录命名建议使用英文
- 避免使用 BearPi、Hihope 等厂商名称
- 保持简短易懂
添加以下文件:
- .fwpkg 格式的固件文件
- readme.md 项目介绍
- metadata.json 元数据文件
- 可选的 .pdf 使用说明文件
提交 Pull Request

metadata.json 规范

{
    "online": true,                                     // 是否上线显示
    "imageUrl": "固件介绍图片URL",                      // 可选,用于展示固件特色
    "packageName": "AT指令固件",                        // 固件名称
    "description": "支持AT指令集的基础通信固件",         // 简短介绍
    "author": "作者名称",                               // 作者信息
    "authorAvatar": "作者头像URL",                      // Github头像等
    "needCode": false,                                 // 是否需要邀请码/内购
    "categories": [
        "通信功能"                                      // 仅可选:通信功能/移动终端/国产替代/物联网/智能家居/娱乐功能/体验尝鲜/实体产品/实体AT/实体产品
    ],
    "chips": [
        "Hi2821",                                      // 支持的芯片型号:Hi2821/Hi2825/Hi3863/Hi3873
        "Hi3863"
    ],
    "brands": [
        "润和",                                        // 支持的品牌:润和/小熊派/开鸿/诚迈科技/华为海思/利尔达/安信可/天工聚创/浩瀚银河
        "小熊派"                                       // 个人/厂商品牌需联系维护者添加
    ],
    "files": [
        {
            "name": "固件说明文档",                     // 文件描述
            "filename": "使用说明.pdf"                  // 文件名
        }
    ],
    "serialcuts": [                                    // 配套的串口命令集
        {
            "name": "命令集合名称",                     // 例如: "多命令集合 专业版"
            "filename": "commands.json"                // 命令集合文件名
        }
    ]
}

分享串口命令

使用软件的图形界面编辑命令集
导出命令集 JSON 文件
在固件目录的 metadata.json 中添加 serialcuts 字段:

{
    // ... 其他固件元数据字段
    "serialcuts": [
        {
            "name": "命令集合名称",           // 例如: "HH-D03 多命令集合 专业版"
            "filename": "命令集合文件名.json"  // 对应固件目录下的JSON文件
        }
    ]
}

将命令集 JSON 文件放在对应的固件目录下

注意：命令集应当与固件配套使用，建议：

提供清晰的命令分类
包含必要的使用说明
确保命令的准确性
可以配套提供PDF格式的命令手册

提交 Issue

使用相应的 Issue 模板
提供详细的问题描述
如果是 bug，请提供:
- 复现步骤
- 环境信息
- 相关日志
- 截图说明

提交 Pull Request

确保 PR 标题格式正确:
- 新固件: feat: Create XXX New Firmware
- 串口命令: feat: Create XXX New Serial Shortcuts
PR 描述需包含:
- 更改内容说明
- 相关 issue 引用
- 测试结果说明
选择正确的 reviewer (@Hny0305Lin)
确保所有检查项通过

注意事项

所有内容必须遵守中国大陆法律法规
固件不得包含:
- 损坏他人设备的代码
- 干扰通信的功能
- 违法违规内容
文档使用简体中文,代码注释推荐中英双语

行为准则

请阅读我们的行为准则。

许可证

通过贡献您的代码，您同意将其授权在项目的 MIT 许可证下。