docs: 新增开发环境指南 doc/dev-guide.md(补齐起步资源包缺失项) #415

Merged
wbtiger merged 1 commits from Taoyouce/gitlink-cli:docs/dev-guide into master 2026-07-14 20:36:34 +08:00
Contributor

背景

赛事「起步资源包」计划提供 doc/dev-guide.md(本地开发、调试、测试的完整指南),但主仓库至今没有该文件,首次贡献者需要自行摸索构建/测试/i18n/单测约定。

内容

新增 doc/dev-guide.md,覆盖:

  • 环境准备(Go ≥1.26,与 go.mod 对齐)与两种构建方式
  • 本地运行与认证冒烟验证
  • 代码结构速览(cmd/shortcuts/internal/skills/examples/doc-changes)
  • 新增 shortcut 的 5 步标准流程(含 i18n 双语键、httptest 单测、doc/changes 变更说明约定)
  • 调试技巧(--debug、api 命令做 ground truth 取证、doctor 自诊断、/api 与 /api/v1 两代端点差异提示)
  • 质量门禁(make check 全套)与 PR 提交规范
  • 常见问题(401 会话态微服务、分页、Windows)

全部命令均在本仓库当前 master 实测可运行;纯文档变更,零代码风险。

## 背景 赛事「起步资源包」计划提供 `doc/dev-guide.md`(本地开发、调试、测试的完整指南),但主仓库至今没有该文件,首次贡献者需要自行摸索构建/测试/i18n/单测约定。 ## 内容 新增 `doc/dev-guide.md`,覆盖: - 环境准备(Go ≥1.26,与 go.mod 对齐)与两种构建方式 - 本地运行与认证冒烟验证 - 代码结构速览(cmd/shortcuts/internal/skills/examples/doc-changes) - 新增 shortcut 的 5 步标准流程(含 i18n 双语键、httptest 单测、doc/changes 变更说明约定) - 调试技巧(--debug、api 命令做 ground truth 取证、doctor 自诊断、/api 与 /api/v1 两代端点差异提示) - 质量门禁(make check 全套)与 PR 提交规范 - 常见问题(401 会话态微服务、分页、Windows) 全部命令均在本仓库当前 master 实测可运行;纯文档变更,零代码风险。
Taoyouce added 6 commits 2026-07-11 00:04:15 +08:00
wbtiger merged commit b8dec07157 into master 2026-07-14 20:36:34 +08:00
Sign in to join this conversation.
No reviewers
No Label
No Milestone
No project
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: Gitlink/gitlink-cli#415
No description provided.