62 lines
1.9 KiB
Markdown
62 lines
1.9 KiB
Markdown
# K. 贡献指南
|
|
|
|
:::tip 欢迎贡献
|
|
感谢关注 EasyGoAdmin！贡献方式：Issue 报告问题/建议、Pull Request 提交改进、文档修正。本指南给出流程与规范。
|
|
:::
|
|
|
|
## 贡献流程
|
|
|
|
```text
|
|
1. Fork 仓库 → 切分支（feature/fix 前缀）
|
|
2. 本地开发（环境搭建见第 2 章）
|
|
3. 提交前门禁：
|
|
后端 go build ./... && go vet ./... && gofmt -l .（应为空）&& go test ./...
|
|
前端 pnpm type:check && pnpm lint:eslint && pnpm build
|
|
4. 提交（Conventional Commits，见 12.3 Git 提交规范）
|
|
5. 发起 PR（描述清晰：动机/改动/验证方式/关联 Issue）
|
|
6. Review 通过后合并
|
|
```
|
|
|
|
## PR 要求
|
|
|
|
```text
|
|
□ 单一主题（一个 PR 一件事）
|
|
□ 通过全部 CI 门禁
|
|
□ 新功能附使用说明/文档更新
|
|
□ 修复附复现步骤与验证结果
|
|
□ 破坏性变更标注 BREAKING CHANGE 并说明迁移
|
|
□ 遵循架构红线（见 12.5 Review 清单——红线项直接打回）
|
|
□ 不引入不必要的依赖
|
|
```
|
|
|
|
## Issue 建议
|
|
|
|
```text
|
|
□ 搜索已有 Issue 避免重复
|
|
□ 环境信息（Go/Node/数据库版本、操作系统）
|
|
□ 复现步骤与期望/实际行为
|
|
□ 日志/截图（敏感信息脱敏——密码/令牌/密钥严禁粘贴）
|
|
□ 功能建议说明使用场景与价值
|
|
```
|
|
|
|
## 开发约定速记
|
|
|
|
```text
|
|
后端：分层红线 / dao.Ctx 唯一入口 / 软删与租户钩子 / service 手维护
|
|
gmeta 全标签 / json 驼峰（登录令牌例外）/ 注释直述当前功能
|
|
前端：三件套对齐 / v-permission / 字典驱动 / storage 封装
|
|
文档：与代码同步变更 / 用词与本项目术语一致
|
|
```
|
|
|
|
## 行为准则
|
|
|
|
```text
|
|
友善、尊重、就事论事。
|
|
维护者保留合并/关闭不当 Issue/PR 的权利。
|
|
安全漏洞请勿公开 Issue——私信维护者（见官网联系渠道）。
|
|
```
|
|
|
|
## 致谢
|
|
|
|
感谢每一位提交 Issue、改进代码、完善文档的贡献者。
|