easygoadmin/easygoadmin-wiki
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

签入版本

Browse Source
This commit is contained in:
小蚂蚁云
2026-10-25 17:24:27 +08:00
parent 48911cc08f
commit fdbeae092a
1010 changed files with 30682 additions and 95274 deletions
Download Patch File Download Diff File Expand all files Collapse all files
EasyGoAdmin_Gin_EleVue/zh/other/contributing.md
+28 -169
View File
@@ -1,188 +1,47 @@
# K. 贡献指南
# L. 贡献指南
:::tip 说明
感谢你对本项目的关注！本文档介绍如何参与项目贡献，包括代码提交、Issue 反馈、PR 流程等。
:::tip 概述
欢迎贡献代码、报告问题与完善文档。本页给出参与方式与质量要求。
:::
## 开发环境搭建
## 参与方式
1. Fork 项目到自己的 Gitee/GitHub 账号
2. 从[官方网站](https://www.rxthink.cn)下载授权源码包
3. 参考 [开发环境准备](/zh/quickstart/environment.html) 安装依赖
4. 创建开发分支：`git checkout -b feature/your-feature`
| 方式 | 说明 |
|---|---|
| 报告问题 | 提 Issue：环境、复现步骤、期望/实际行为、日志（脱敏） |
| 提交修复 | Fork → 分支 → PR，关联 Issue 编号 |
| 功能建议 | Issue 讨论先行，大改动先对齐方案再动手 |
| 文档完善 | 文档站与代码同仓，PR 同样适用本指南 |
## 分支策略
## 代码要求
| 分支 | 用途 | 说明 |
|------|------|------|
| `master` | 主分支 | 稳定版本，只接受 PR 合并 |
| `feature/*` | 功能分支 | 新功能开发，完成后合并到 master |
| `hotfix/*` | 修复分支 | 紧急修复，从 master 拉取，修复后合并回 master |
```text
master ────●───────●───────●───── (发布)
↑ ↑
feature/a ──●──● feature/b ──●──●
```
## Commit 规范
提交信息遵循 [Conventional Commits](https://www.conventionalcommits.org/) 格式：
```html
<type>(<scope>): <subject>
<body>
<footer>
```
### Type 类型
| 类型 | 说明 | 示例 |
|------|------|------|
| `feat` | 新功能 | `feat(user): 添加用户导入功能` |
| `fix` | 修复 bug | `fix(auth): 修复 Token 过期未返回 401` |
| `docs` | 文档更新 | `docs: 更新部署文档` |
| `style` | 代码格式（不影响功能） | `style: 格式化代码` |
| `refactor` | 重构（非新功能非修复） | `refactor(service): 重构分页查询逻辑` |
| `perf` | 性能优化 | `perf(query): 优化 N+1 查询` |
| `test` | 测试相关 | `test: 添加用户模块单元测试` |
| `chore` | 构建/工具相关 | `chore: 更新依赖版本` |
### 示例
```text
feat(generator): 支持树形表格模板生成
- 新增 ui2/ 树形模板目录
- 自动识别 parent_id/pid 字段
- 支持 el-tree-select 组件
Closes #123
```
## PR 流程
### 1. 准备工作
- 遵守 [第 12 章 规范标准](/zh/standards/api-response.html)：数据访问铁律、模块规约、信封与分页契约
- 提交信息符合 [12.5 Git 提交规范](/zh/standards/git.html)
- PR 前本地通过：
```bash
# 1. 同步上游代码
git fetch upstream
git rebase upstream/master
# 2. 创建功能分支
git checkout -b feature/your-feature
# 3. 开发并提交
git add .
git commit -m "feat(xxx): 添加xxx功能"
# 4. 推送到自己的仓库
git push origin feature/your-feature
make check # 后端：fmt + vet + test-short + check-config
cd ui && pnpm type:check && pnpm lint:eslint # 前端
```
### 2. 创建 PR
- 新功能附测试或说明不测原因；修 bug 附复现描述
- 生成器模板改动与产物同提交
- 标题简洁明了，遵循 Commit 规范
- 描述清楚做了什么、为什么做、怎么测试的
- 关联相关的 Issue（如 `Closes #123`）
- 附上截图或 GIF（如有 UI 变更）
## PR 审查关注点
### 3. PR 模板
见 [12.7 代码审查清单](/zh/standards/code-review.html)。阻塞项：数据访问红线、契约稳定性、错误处理、权限与敏感信息、配置一致性。
```markdown
## 变更说明
## 文档贡献
简要描述本次变更的内容。
## 变更类型
- [ ] 新功能 (feat)
- [ ] Bug 修复 (fix)
- [ ] 文档更新 (docs)
- [ ] 代码重构 (refactor)
- [ ] 性能优化 (perf)
## 测试情况
- [ ] 本地测试通过
- [ ] 添加了单元测试
- [ ] 手动验证了功能
## 关联 Issue
Closes #xxx
```
### 4. 代码审查
- 至少一人审查通过后方可合并
- 审查关注：正确性 > 安全性 > 可维护性 > 性能
- 参考 [代码审查清单](/zh/standards/code-review.html)
## Issue 规范
### Bug Report
```markdown
## Bug 描述
简要描述遇到的问题。
## 复现步骤
1. 打开 xxx 页面
2. 点击 xxx 按钮
3. 输入 xxx 数据
4. 看到错误
## 期望行为
描述你期望的正确行为。
## 实际行为
描述实际发生的行为。
## 环境信息
- OS: Windows 11
- PHP: 8.2
- ThinkPHP: 6.1.x
- Node.js: 22.x
- Browser: Chrome 120
```
### Feature Request
```markdown
## 功能描述
简要描述你希望添加的功能。
## 使用场景
描述这个功能的使用场景和价值。
## 方案建议
如果有实现思路，请描述。
```
## 代码风格
- PHP：遵循 PSR-12 规范
- TypeScript/Vue：遵循 ESLint + Prettier 配置
- 详见 [前端编码规范](/zh/standards/frontend-code.html) 和 [后端编码规范](/zh/standards/backend-code.html)
- 页标题编号与侧边栏一致；跨章链接用绝对路径 + `.html`
- 代码示例首行注释标注源文件路径
- 示例代码须与当前代码行为一致（过期示例比没有更糟）
## 行为准则
- 尊重每一位贡献者
- 建设性地提出意见和建议
- 专注于对社区有益的事情
- 不接受任何形式的骚扰
对事不对人；技术分歧以可验证的事实收敛；帮助新手理解而非劝退。
## 总结
## 相关
贡献指南涵盖开发环境搭建、分支策略、Commit 规范、PR 流程、Issue 模板、代码风格等内容。核心原则：遵循规范、充分测试、清晰描述、尊重他人。
- [12.7 代码审查清单](/zh/standards/code-review.html)
- [11.11 CI/CD 与质量门禁](/zh/deploy/ci-cd.html)
EasyGoAdmin_Gin_EleVue/zh/other/declare.md
+21 -55
View File
@@ -1,71 +1,37 @@
# L. 免责声明
# M. 免责声明
:::danger 重要提示
任何用户在使用本团队研发的系列软件产品（以下简称「本产品」）前，请仔细阅读并透彻理解本声明。选择不使用本产品，可随时停止使用；一旦使用本产品，即视为对本声明全部内容的认可和接受。
:::tip 说明
使用本项目及其文档前请阅读以下声明。
:::
## 一、产品性质
## 软件按"现状"提供
1. 本产品是一套企业级数据中台解决方案的标准化软件架构，主要用于更高效地开发数据中台系统。本产品为标准化的后台管理框架，不涉及任何实际业务功能，不采集、存储或传输任何用户数据。
本项目按"现状"提供，不提供任何明示或暗示的保证，包括但不限于适销性、特定用途适用性与不侵权的保证。因使用本软件产生的任何直接或间接损失，作者与贡献者不承担责任。
2. 本产品通过授权方式向企业和开发者提供使用许可。用户获得授权后，可在授权范围内使用和修改本产品，但不得以任何形式对外泄露、传播、转售或提供本产品源代码。
## 安全责任
## 二、授权与使用规范
- 生产部署的安全加固（[11.8](/zh/deploy/security.html)）由部署方落实：更换默认密钥、关闭生成器与文档端点、收敛网络暴露面
- 默认配置中的示例密钥仅用于开发环境，**严禁原样用于生产**
- 发现安全问题请私下报告（勿公开 Issue 暴露细节），给修复留出窗口
3. 用户应严格遵守本团队出具的《软件授权协议》，在授权范围内合理使用本产品。未经授权或超出授权范围的使用行为，本团队有权立即终止授权并追究法律责任。
## 第三方组件
4. 用户应采取必要的技术和管理措施，确保所授权产品的源代码安全，防止源代码泄露、被窃取或被未授权人员访问。因用户保管不善导致源代码泄露的，由用户承担全部责任。
本项目使用众多开源组件（见 go.mod 与 ui/package.json），各组件遵循其自身许可证。使用本项目即表示自行承担对传递依赖许可证的合规义务。
5. 用户承诺秉持合法、合理的原则使用本产品，不利用本产品进行任何违法、侵害他人合法利益等恶意行为，亦不将本产品运用于任何违反中华人民共和国法律法规的 Web 平台。
## 数据与内容
6. 用户在使用本产品进行二次开发或集成第三方服务时，应自行评估并承担由此产生的技术风险、安全风险和法律风险。本团队不对用户二次开发后的系统稳定性、安全性和合规性承担责任。
- 演示数据（种子脚本）仅供体验，生产使用前应清理与定制
- 用户经本系统发布的内容（文章、公告等）由用户自身负责合规
- IP 归属地数据（ip2region）为离线库，准确性以数据源为准
7. 用户应自行负责生产环境的数据备份、安全防护和容灾方案。因用户自身操作不当、配置错误或未做好数据备份而导致的任何损失，本团队不承担责任。
## 文档
## 三、知识产权
文档尽力与代码同步，但可能存在滞后或笔误。以代码行为为准；发现文档错误欢迎提交修正（[L. 贡献指南](/zh/other/contributing.html)）。
8. 本团队对本产品拥有完整的知识产权（包括但不限于商标权、专利权、著作权、商业秘密等），上述权利均受中华人民共和国及相关国际法律法规保护。
## 商标与品牌
9. 任何单位或个人不得在未经本团队书面授权的情况下，对本产品本身申请任何形式的知识产权（包括但不限于软件著作权、专利、商标等）。
文中出现的各技术栈名称与商标归其各自所有者。
10. 任何单位或个人不得将本产品的源代码、文档、设计等知识产权用于开发与本产品功能实质性相似的竞品，或以任何形式损害本团队的商业利益。
## 相关
11. 本产品包含的第三方源码和二进制文件之版权信息另行标注，用户使用时应遵守相应的第三方许可协议。
## 四、保密义务
12. 用户应对本产品的源代码、技术文档、架构设计、业务逻辑等一切技术信息承担保密义务。未经本团队书面同意，不得以任何形式向任何第三方披露、泄露或提供上述信息。
13. 用户不得将本产品源代码上传至任何公开代码仓库、代码分享平台或任何可被第三方访问的网络空间。
14. 用户不得对本产品进行反编译、反汇编或以其他方式试图获取本产品的源代码（授权范围内已提供源代码的情况除外）。
## 五、免责声明
15. 本产品按「现状」提供，不附带任何明示或暗示的担保，包括但不限于适销性、特定用途适用性、不侵权、无安全漏洞等担保。
16. 本团队不保证本产品无安全漏洞。如发现安全漏洞，本团队将尽力在合理时间内修复，但不对因安全漏洞导致的任何直接或间接损失承担责任。用户应自行做好安全防护措施。
17. 本团队不保证本产品服务的连续性和可用性。因系统维护、升级、不可抗力等原因导致的服务中断，本团队不承担责任。
18. 任何单位或个人因下载、安装、使用本产品而产生的任何意外、疏忽、合约毁坏、诽谤、版权或知识产权侵犯及其造成的损失（包括但不限于直接、间接、附带或衍生的损失），本团队不承担任何法律责任。
19. 用户明确并同意本声明条款列举的全部内容，对使用本产品可能存在的风险和相关后果将完全由用户自行承担，本团队不承担任何法律责任。
20. 本产品可能包含指向第三方网站或资源的链接。本团队对第三方网站或资源的可用性、内容、广告、产品或其他材料不承担任何责任。
## 六、违约责任
21. 用户违反本声明任一条款的，本团队有权立即终止授权，要求用户停止使用并销毁所有源代码副本，同时保留追究法律责任的权利。
22. 因用户违反本声明导致本团队遭受损失的（包括但不限于直接经济损失、商誉损失、维权合理费用等），用户应予以全额赔偿。
## 七、声明变更
23. 本团队有权随时对本声明条款及附件内容进行单方面的变更，并以消息推送、网页公告等方式予以公布，公布后立即自动生效，无需另行单独通知。若在本声明内容公告变更后继续使用的，表示已充分阅读、理解并接受修改后的声明内容。
24. 如果本声明的任何部分被认为无效或不可执行，则该部分将被解释为反映本团队的初衷，其余部分仍具有完全效力。不可执行的部分声明，并不构成放弃执行该声明的权利。
## 八、适用法律
25. 本声明的解释、效力及争议解决均适用中华人民共和国法律。因本声明产生的任何争议，双方应首先友好协商解决；协商不成的，任何一方均有权向本团队所在地有管辖权的人民法院提起诉讼。
- [L. 贡献指南](/zh/other/contributing.html)
EasyGoAdmin_Gin_EleVue/zh/other/sponsor.md
-40
View File
@@ -1,40 +0,0 @@
# M. 广告赞助
:::tip 特别说明
1. 投放广告不得与官方全系产品存在结构性冲突和竞争
2. 广告内容需符合国家法律法规，不得包含虚假、误导性信息
3. 广告素材需经官方审核通过后方可上线，审核周期 1-3 个工作日
4. 广告位按签约顺序排期，先到先得，名额满后需等待下一期
5. 合作期间如遇产品重大版本更新，官方有权提前 7 天通知调整展示位置
6. 年费合作支持一次免费素材更换（限同尺寸），额外更换按次收费
:::
## 关于我们
小蚂蚁云团队专注于企业级后台管理解决方案，产品覆盖 ThinkPHP、Laravel 多技术栈，提供 ElementPlus / AntDesign / NaiveUI 多前端版本。官网月均访问量 10 万+，用户群体以企业开发者和技术决策者为主。
## 赞助优势
**精准触达**：用户群体以中大型企业开发者、技术负责人、架构师为主，与开发者工具、云服务、技术培训等产品高度契合。
**持续曝光**：品牌展示在官网首页、文档站侧边栏、文章页等显眼位置，获得长期稳定的流量曝光。
**灵活形式**：支持横幅广告、侧边栏广告、内容植入、专题合作等多种形式，满足不同推广需求。
**效果可追踪**：提供曝光量、点击率、转化率等数据报告，帮助实时优化投放策略。
## 合作方案
| 类别 | 展示位置 | 素材尺寸 | 名额 | 年费 |
|:-----|:---------|:---------|:-----|:-----|
| A1 | 全站头部 Banner | 2520×144px | 仅 1 位 | 50,000 元 |
| H1 | 首页青铜赞助商 | 1200×300px | 仅 4 位 | 24,000 元 |
| H2 | 首页白金赞助商 | 1200×300px | 仅 4 位 | 48,000 元 |
| D1 | 文档页侧边栏（大） | 1200×300px | 仅 4 位 | 48,000 元 |
| D2 | 文档页侧边栏（小） | 300×300px | 仅 3 位 | 36,000 元 |
支持包年（推荐）、包月、按展示量（CPM）、按点击量（CPC）等灵活计费方式，亦可定制专属合作方案。
## 联系我们
若有投放意向，请发送邮件至 rxthinkcmf@163.com 咨询详细事宜。