签入版本
This commit is contained in:
@@ -0,0 +1,61 @@
|
||||
# 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、改进代码、完善文档的贡献者。
|
||||
@@ -0,0 +1,54 @@
|
||||
# L. 免责声明
|
||||
|
||||
:::tip 概述
|
||||
使用本项目前请阅读以下免责声明。下载或使用本软件即视为同意本声明。
|
||||
:::
|
||||
|
||||
## 软件按"现状"提供
|
||||
|
||||
```text
|
||||
本软件按"现状"提供,不附带任何明示或默示的保证,包括但不限于适销性、
|
||||
特定用途适用性与非侵权性的保证。在适用法律允许的最大范围内,
|
||||
作者与贡献者不对任何直接、间接、附带、特殊、惩罚性或后果性损失负责。
|
||||
```
|
||||
|
||||
## 安全与部署责任
|
||||
|
||||
```text
|
||||
1. 本项目为开源基座框架——生产部署的安全加固(密钥/限流/HTTPS/权限收紧)
|
||||
由使用方负责,参见 11.8 安全加固清单。
|
||||
2. 默认凭证(admin/123456)、默认密钥、万能验证码(bypassCode)仅用于
|
||||
开发调试——使用方有义务在上线前全部更换/清空。
|
||||
3. 数据库定稿脚本、迁移工具的执行结果需使用方自行验证与备份;
|
||||
-drop-target-first 等破坏性参数的后果由使用方承担。
|
||||
4. 多租户/数据权限为企业级能力基线——具体业务的权限模型评审由使用方完成。
|
||||
```
|
||||
|
||||
## 第三方依赖
|
||||
|
||||
```text
|
||||
本软件依赖众多开源组件(GoFrame、Element Plus、Excelize、golang-jwt 等),
|
||||
各依赖遵循其自身的开源协议。依赖的安全漏洞修复随版本演进提供,
|
||||
但及时升级由使用方决策。
|
||||
```
|
||||
|
||||
## 数据与合规
|
||||
|
||||
```text
|
||||
1. 使用本软件收集、存储、处理的数据合规性(含个人信息保护)由使用方负责。
|
||||
2. 操作日志/登录日志含用户行为数据——日志的保留、访问控制与销毁策略
|
||||
由使用方按所在地区法规制定(默认保留 90 天可配置)。
|
||||
3. Excel 导入导出、文件上传等功能的数据安全由使用方按业务场景加固。
|
||||
```
|
||||
|
||||
## 商标与品牌
|
||||
|
||||
```text
|
||||
EasyGoAdmin 名称与标识的使用应遵守品牌规范;
|
||||
二次分发时请保留版权信息与本声明。
|
||||
```
|
||||
|
||||
## 联系方式
|
||||
|
||||
+ 官网:[https://www.easygoadmin.vip](https://www.easygoadmin.vip)
|
||||
+ Gitee 仓库:[https://gitee.com/easygoadmin/EasyGoAdmin_GoFrame_EleVue](https://gitee.com/easygoadmin/EasyGoAdmin_GoFrame_EleVue)
|
||||
@@ -0,0 +1,45 @@
|
||||
# M. 广告赞助
|
||||
|
||||
:::tip 概述
|
||||
如果本项目对你的工作有帮助,欢迎通过赞助支持它的持续演进。赞助用于:文档维护、安全跟进、新特性开发与长期技术支持。
|
||||
:::
|
||||
|
||||
## 为什么赞助
|
||||
|
||||
```text
|
||||
+ 持续维护:跟进 GoFrame/Vue/Element Plus 生态升级与安全补丁
|
||||
+ 文档完善:保持文档与代码同步(本套 145 页开发者文档的编写与维护)
|
||||
+ 特性演进:多实例能力增强、导出增强、数据权限扩展档等规划项
|
||||
+ Issue 优先响应:赞助者问题优先排期
|
||||
```
|
||||
|
||||
## 赞助方式
|
||||
|
||||
请访问官网获取最新赞助渠道:
|
||||
|
||||
+ 官网:[https://www.easygoadmin.vip](https://www.easygoadmin.vip)
|
||||
|
||||
## 企业支持
|
||||
|
||||
企业级需求(定制开发、私有化部署支持、长期技术支持合约)请通过官网联系方式洽谈。
|
||||
|
||||
## 开源免费说明
|
||||
|
||||
```text
|
||||
本项目基于 Apache-2.0 协议开源——个人与企业可免费用于商业项目
|
||||
(保留版权与协议声明)。赞助完全自愿,不影响功能完整性(无付费墙)。
|
||||
```
|
||||
|
||||
## 其他支持方式
|
||||
|
||||
即使不赞助,以下方式同样珍贵:
|
||||
|
||||
```text
|
||||
★ Gitee 点 Star(让更多人发现项目)
|
||||
🍴 Fork 后贡献 PR(见 K. 贡献指南)
|
||||
📝 提交 Issue 报告 Bug 或建议
|
||||
📣 在团队/社区推荐本项目
|
||||
📄 完善文档(发现错漏欢迎直接 PR)
|
||||
```
|
||||
|
||||
感谢每一份支持!
|
||||
Reference in New Issue
Block a user