mirror of https://github.com/qingchencloud/clawpanel.git synced 2026-05-06 20:02:49 +08:00

Files

- 添加 README、LICENSE (MIT)、CONTRIBUTING、CHANGELOG
- 添加 GitHub Issue/PR 模板和 FUNDING 配置
- 添加 CI/CD 工作流（ci.yml + release.yml）
- 添加项目文档页面 (docs/index.html)
- 添加 logo 和社群二维码图片资源
- 添加开发和构建脚本 (dev.sh + build.sh)
- 更新 package-lock.json 依赖

2026-02-28 03:23:39 +08:00

2.1 KiB

Raw Blame History

贡献指南

感谢你对 ClawPanel 项目的关注！以下是参与贡献的相关说明。

开发环境要求

依赖	最低版本	说明
Node.js	18+	前端构建
Rust	stable	Tauri 后端编译
Tauri CLI	v2	`cargo install tauri-cli --version "^2"`

快速开始

# 克隆仓库
git clone https://github.com/qingchencloud/clawpanel.git
cd clawpanel

# 安装前端依赖
npm install

# 启动开发模式
cargo tauri dev

分支策略

所有开发基于 main 分支
新功能分支：feature/功能描述（例如 feature/log-export）
修复分支：fix/问题描述（例如 fix/model-save-crash）
完成后发起 PR 合并回 main

提交规范

提交信息采用 Conventional Commits 格式：

<类型>(可选范围): 简要描述

类型说明

类型	说明
`feat`	新功能
`fix`	修复 Bug
`docs`	文档变更
`style`	代码格式调整（不影响逻辑）
`refactor`	重构（非新功能、非 Bug 修复）
`test`	测试相关
`chore`	构建/工具/依赖变更

示例

feat(model): 新增模型批量测试功能
fix(gateway): 修复端口配置未生效的问题
docs: 更新安装说明

PR 流程

Fork 本仓库并克隆到本地
从 main 创建新分支
完成开发并进行本地测试
确保代码风格一致、注释完整
提交并推送到你的 Fork 仓库
发起 Pull Request，描述清楚变更内容和测试情况
等待代码审查，根据反馈修改

代码规范

前端：使用 Vanilla JS，不引入第三方框架
注释：所有代码注释使用中文
风格：简洁清晰，避免过度封装
命名：变量和函数使用驼峰命名（camelCase），CSS 类名使用短横线命名（kebab-case）
资源：静态资源本地化，禁止引用远程 CDN

问题反馈

如果发现 Bug 或有功能建议，欢迎通过 GitHub Issues 提交。

2.1 KiB Raw Blame History Unescape Escape