Skip to content

📣 邀请共建 GoNavi · Call for Contributors（欢迎提 PR） #671

Open
Open
📣 邀请共建 GoNavi · Call for Contributors（欢迎提 PR）#671
Labels
documentationImprovements or additions to documentationhelp wantedExtra attention is needed

Description

@Syngnat
Syngnat
opened on Jul 21, 2026

📣 欢迎共建 GoNavi · Call for Contributors

置顶说明：这是社区共建入口。欢迎 Star、Fork、提 Issue、提 PR —— 哪怕只是修一个文案、补一条测试、适配一个数据源，都算真正的贡献。

🎁 共建者可申请共享 AI token 池（API Key）：见下文「共建者 AI 额度」；赞助商主页：华龙中转站。

GoNavi 是一款 Wails (Go) + React 构建的跨平台数据库客户端：原生 WebView、约 30MB 量级体积、内置 AI / MCP，覆盖 SQL · 缓存 · 向量 · 消息 · 搜索 · 时序 · 国产库。

仓库：Syngnat/GoNavi · 文档：README.zh-CN.md · 贡献指南：CONTRIBUTING.zh-CN.md

目前核心维护力量偏少，希望有更多人一起把产品打磨得更稳、更强、更好用。无论你是学生、工程师，还是数据库 / 前端 / 开源爱好者，都非常欢迎加入。

🎯 我们在找什么样的人

方向 你可以做什么 适合你如果…
后端 / 驱动 数据源适配、连接协议、驱动代理、SQL/对象浏览 熟悉 Go 或某类数据库协议
前端 / UX 工作台、DataGrid、连接向导、主题与 i18n 熟悉 React / TypeScript
AI / MCP 工具注册、Agent 上下文、MCP Server/Client、安全策略 关心 LLM / Agent 工作流
测试与质量 复现 Bug、补单测/集成测、回归清单 喜欢把边界场景钉死
文档与社区 中英文 README、使用指南、Issue 分类、回复新人 擅长把复杂事写清楚
CI / 打包 多平台构建、驱动产物、Docker/Web Server 部署 熟悉 GitHub Actions / 交叉编译

没有「必须先成为专家」的门槛。 第一次贡献可以很小：错别字、图标、无障碍、某个库的连接参数校验、一条失败用例 —— 我们都欢迎。

🎁 共建者 AI 额度（华龙中转站赞助）

感谢 华龙中转站（AI API Gateway / 多模型中转 · 国内直连高速端点）赞助 GoNavi 开源开发。

为降低共建门槛，赞助方向本仓库提供 合计 500 亿（50B）token 额度，规则如下：

项目 说明
额度形态 全项目共享 1 份 50B，不是「每位共建者各 50B」
使用方式 经维护者确认后，通过 API Key 接入 华龙中转站
用途限制 仅限 GoNavi 项目开发与协作（AI 辅助编码、多模型联调、Agent/MCP 场景验证等）
禁止 二次分发、转售、用作公共免费 API、与 GoNavi 无关的个人/商业消耗
如何申请 在本 Issue 用文末 「统一留言模板」 留言，把「是否需要赞助 API Key」填「是」；维护者审核后发放 Key，并从共享池记账

README 中的赞助商章节主要做品牌致谢与产品推广；额度申请、规则与共建激励以本 Issue 为准。

如何领 API Key（别再看另一套模板）

共建者不会自动拿到 Key。流程：

  1. 在本 Issue 发一条评论
  2. 直接用文末的 「统一留言模板」（全 Issue 只有这一套）
  3. 把其中的 「是否需要赞助 API Key」填成「是」，并写清打算用在哪些 GoNavi 相关事上
  4. 维护者审核后，再单独把可用的 API Key 发给你，用来访问上面的 共享 50B 额度池

一句话：申请 Key = 用文末同一张表留言；不是每人一份 50B，也不是再填第二张表。

English (token pool)

Hualong Transfer Station sponsored a single shared 50B token pool for GoNavi co-maintainers (not 50B per person), accessed via API Key after maintainer approval. Project-related use only. Apply by commenting on this issue.

🚀 5 分钟上手贡献

# 1. Fork 后克隆
git clone https://github.com/<your-name>/GoNavi.git
cd GoNavi

# 2. 始终基于 dev 开发（默认集成分支）
git checkout dev
git pull origin dev
git checkout -b fix/your-topic   # 或 feature/your-topic

# 3. 本地开发
# 需要：Go 1.21+ · Node 18+ · Wails CLI
go install github.com/wailsapp/wails/v2/cmd/wails@v2.11.0
wails dev
# 或（Go 导出签名未变时更快）
node tools/wails-fast-dev.mjs

提 PR 的硬性约定

  1. 目标分支必须是 dev（不要直接打 main）
  2. 一个 PR 只做一类事，描述写清：背景 / 变更点 / 影响范围 / 验证方式
  3. UI 变更尽量附截图或录屏
  4. 提交信息建议：emoji type(scope): 中文描述
    例：✨ feat(redis): 支持 Stream 浏览 · 🔧 fix(datagrid): 修复横向滚动错位
  5. 大改动请先开 Issue 或 Draft PR 对齐方案

完整说明见：CONTRIBUTING.zh-CN.md · CONTRIBUTING.md

🧩 推荐切入点（按难度）

适合第一 PR（Good first contribution）

  • 文案 / i18n 缺失与不一致（shared/i18n、frontend/src/i18n）
  • README / 文档错漏、截图更新、使用说明补全
  • 小范围 UI 体验：空状态、加载态、错误提示更友好
  • 已确认的小 Bug 修复（请先在 Issue 里认领，避免撞车）
  • 补单元测试：纯函数、解析逻辑、配置校验

中等难度

  • 某个可选驱动代理的能力增强（对象浏览、分页、类型映射）
    参考：cmd/optional-driver-agent/、internal/db/
  • Redis / Kafka / Mongo 等非 SQL 数据源的浏览与操作体验
  • DataGrid 性能、快捷键、批量编辑边界场景
  • Web Server（实验中）鉴权、部署文档、健康检查与运维体验

进阶 / 高价值

  • 新数据源接入（驱动代理 + 前端连接配置 + 图标 + 文档）
  • AI 工具链：上下文组装、安全级别、MCP 工具桥接
  • 跨平台构建与驱动发布链路（tools/、.github/workflows/）
  • 同步 / 审计 / 导出等核心工作流的稳定性

不确定从哪下手？在本 Issue 留言你的技术栈 + 每周大概可投入时间，维护者会帮你匹配任务。

📋 开 Issue / 提 PR 怎么写更高效

Bug

  • 版本 / 系统 / 数据源类型
  • 最小复现步骤
  • 期望 vs 实际
  • 日志或截图（注意脱敏：密码、连接串、业务数据）

功能需求

  • 使用场景（你在什么工作流里卡了）
  • 是否已有替代方案
  • 若涉及新数据源：协议、鉴权方式、你能协助验证的环境

PR 自检清单

  • 基于最新 dev
  • 变更范围聚焦，无无关格式化大扫荡
  • 本地能编译 / 关键路径自测过
  • 描述里写了验证步骤
  • 不引入密钥、真实连接串、隐私数据

🏷️ 标签说明（方便认领）

标签 含义
good first issue 适合新人的小任务
help wanted 维护者明确欢迎社区接手
bug / enhancement / documentation 类别
plan to do 已纳入规划，欢迎讨论实现
claimed 已被认领，进行中（评论「我想做」自动添加）

欢迎在感兴趣的 Issue 下评论 「我想做」（或 /claim）：

  • 🤖 机器人会自动认领：能指派则加入 Assignees，否则打上 claimed 标签并写入认领状态
  • 同一 Issue 同时只允许一人认领；取消请评论 「取消认领」 或 /unclaim
  • 认领后我们也会协助拆分范围与验收标准

说明：GitHub 限制只有仓库协作者才能成为正式 Assignee；外部贡献者认领同样有效，PR 合入不受影响。

🤝 协作原则

  • 善意默认：PR 评审会给具体建议，而不是甩锅
  • 最小可合并：宁可小步合入，也不要巨型难审 PR
  • 安全与隐私优先：连接密钥与业务数据不得进仓库 / 日志示例
  • 方向对齐：与现有架构明显冲突的大改动，请先 Issue 讨论
  • 署名与致谢：合入的贡献会出现在 Git 历史与 Release 说明中；持续贡献者欢迎进一步成为维护协作者

💬 沟通渠道

  • 技术讨论 / 任务认领：优先在本 Issue 或相关 Issue 下评论
  • Bug / 需求：用仓库 Issue 模板提交
  • 其他反馈：见仓库现有反馈相关 Issue

如果你只是路过：点个 ⭐ 也是很大的支持；如果你愿意写代码 —— 现在就是最好的时机。

English (short)

GoNavi is a native-feeling, ~30MB-class multi-data-source client (Wails/Go + React) with first-class AI/MCP. We are short on co-maintainers and actively welcome PRs.

  • Target branch: dev only
  • Guide: CONTRIBUTING.md
  • Great first PRs: docs/i18n, small bugs, tests, UX polish, driver improvements
  • Comment below with your stack if you want a task matched to you

Thank you for helping navigate every data source — together.

统一留言模板（报名共建 / 申请 API Key 都用这一份）

在本 Issue 评论里复制下面内容填空即可（全 Issue 只有这一套，不用找第二张表）：

- 昵称 / GitHub：
- 联系邮箱：（如果你的 GitHub 资料未公开邮箱，请务必填写，否则无法接收 API Key）
- 技术栈：
- 感兴趣方向：（驱动 / 前端 / AI / 文档 / CI …）
- 每周大概可投入：
- 是否需要推荐 good first issue：是 / 否
- 是否需要赞助 API Key：是 / 否
- 若需要 Key，打算用在：（写代码辅助 / 模型联调 / MCP 验证 … / 不需要则填「无」）

说明：

  • 只想报名共建、暂不要额度 → API Key 填 否
  • 需要用共享 50B 额度 → API Key 填 是，并写清用途（仅限 GoNavi 项目相关）
  • 维护者确认后才会发 Key；额度是全项目共享池，不是人均 50B
  • 如果你 GitHub 资料中已公开邮箱，则联系邮箱可留空

一起把 GoNavi 做成真正好用的数据工作台。 🚀
Looking forward to your first PR.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationhelp wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions