go-admingo-admin
  • 指南
  • 开发
    • 进阶
    • 指令
  • 前端
  • 高阶
  • 授权
  • 帮助
  • GitHub
  • Changelog
⌘ K
获取帮助
最后更新时间:
Open-source MIT Licensed | Copyright © 2020-present
Powered by go-admin-team
‌
‌
‌
‌

获取帮助

一、先自查

多数问题在文档里已有答案,按下面的顺序找通常最快:

  1. 常见问题 —— CGO 编译失败、数据库连不上、依赖安装报错等高频问题都在这里;
  2. 配置参考 —— 配置项没生效、redis 配了没反应、token 过期时间不对,先对照这一页确认字段是否被真正读取;
  3. 快速开始 —— 启动流程中的某一步失败时,回到这里逐步核对;
  4. 搜索已有 issue —— 在 issues 中搜索报错关键词,很多问题别人已经遇到过,注意也要搜索已关闭的。

二、提交 issue

自查无果时,欢迎提交 issue。

带上下面这些信息,问题通常能快很多定位;只描述"启动报错了"往往需要多轮追问才能开始排查:

sh
# 1. 版本号
$ ./go-admin version
# 2. Go 版本与操作系统
$ go version

除此之外还请附上:

  • 完整的报错输出,而不是截取的一行。日志请用代码块包裹,不要用截图——截图无法被搜索到,后来遇到同样问题的人就找不到这个 issue;
  • 复现步骤,从哪一步开始出错;
  • 相关配置,注意先删掉数据库密码、jwt.secret 等敏感信息;
  • 数据库类型与版本(MySQL / PostgreSQL / SQLite / SQL Server)。

WARNING

不要在 issue、群聊或任何公开场合贴出未脱敏的配置文件。database.source 里含有数据库账号密码,jwt.secret 泄露后可被用来伪造任意用户的 token。

三、参与共建

  • 文档有错漏:本站源码在 go-admin-doc,欢迎提 issue 或直接 PR;
  • 代码贡献:go-admin 的开发约定见仓库根目录的 AGENTS.md,标准模块的写法可参照 app/demo/;
  • 功能建议:同样通过 issue 提出,说明使用场景比描述功能本身更有帮助。

四、社区交流

wenjianzhang
微信 公众号 QQ 交流群 哔哩哔哩

INFO

群内提问同样建议附上版本号与完整报错。紧急或复杂的问题,仍建议提交 issue —— 有记录、可检索,也便于后来人查阅。

五、商业支持

需要更完整的功能与技术支持,可以了解 商业授权。