docs: add dubbo-go agent skills#3340
Conversation
Signed-off-by: Oxidaner <18622412361@163.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #3340 +/- ##
===========================================
+ Coverage 46.76% 52.54% +5.77%
===========================================
Files 295 492 +197
Lines 17172 37871 +20699
===========================================
+ Hits 8031 19900 +11869
- Misses 8287 16365 +8078
- Partials 854 1606 +752 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Adds a set of dubbo-go “agent skill” documents under .agents/skills/ to help route work to the right subsystem and provide reference flows/validation guidance for reviews and changes across the codebase.
Changes:
- Introduces subsystem-specific skill definitions (config/runtime/protocol/registry/metadata/cluster/filters+observability/tools).
- Adds reference “flow” documents for each skill to standardize investigation and validation steps.
- Adds a top-level project/domain guide skill with architecture map and project rules references.
Reviewed changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| .agents/skills/dubbo-go-tools/SKILL.md | Defines scope/workflow for tooling/codegen-related changes. |
| .agents/skills/dubbo-go-tools/references/tooling-flow.md | Documents tools areas, Make targets, and nested-module testing guidance. |
| .agents/skills/dubbo-go-runtime/SKILL.md | Defines scope/workflow for public runtime lifecycle and client/server construction. |
| .agents/skills/dubbo-go-runtime/references/client-server-lifecycle.md | Documents consumer/provider/proxy/shutdown lifecycle flows. |
| .agents/skills/dubbo-go-registry/SKILL.md | Defines scope/workflow for registry + service discovery behavior. |
| .agents/skills/dubbo-go-registry/references/registry-discovery-flow.md | Documents registry contracts, extension points, and notification rules. |
| .agents/skills/dubbo-go-protocol/SKILL.md | Defines scope/workflow for protocol + transport implementations. |
| .agents/skills/dubbo-go-protocol/references/protocol-flow.md | Documents export/refer/url/destroy rules and wrapper behavior. |
| .agents/skills/dubbo-go-observability-filters/SKILL.md | Defines scope/workflow for filters, metrics, tracing, logging, TPS, etc. |
| .agents/skills/dubbo-go-observability-filters/references/filter-observability-flow.md | Documents filter contract and chain construction rules. |
| .agents/skills/dubbo-go-metadata/SKILL.md | Defines scope/workflow for metadata info/service/report/mapping changes. |
| .agents/skills/dubbo-go-metadata/references/metadata-flow.md | Documents metadata collection/reporting/service/mapping flow. |
| .agents/skills/dubbo-go-domain/SKILL.md | Provides project-wide guide and routing to narrower subsystem skills. |
| .agents/skills/dubbo-go-domain/references/project-rules.md | Documents compatibility, generated-file rules, and validation selection. |
| .agents/skills/dubbo-go-domain/references/architecture-map.md | Maps subsystem ownership and end-to-end flows. |
| .agents/skills/dubbo-go-config/SKILL.md | Defines scope/workflow for configuration loading/config center/hot reload. |
| .agents/skills/dubbo-go-config/references/config-flow.md | Documents config loader entry points, injection, and hot reload behavior. |
| .agents/skills/dubbo-go-cluster/SKILL.md | Defines scope/workflow for cluster strategies, routing, and load-balancing. |
| .agents/skills/dubbo-go-cluster/references/routing-cluster-flow.md | Documents invocation path and cluster/directory/router contracts. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
pls check this https://github.com/Tsukikage7/dubbo-go-skills which in under construction |
|
@Tsukikage7 check this |
AlexStocks
left a comment
AlexStocks
left a comment
There was a problem hiding this comment.
Code Review — dubbo-go #3340
不建议合并，需重大修改。
P0 × 1：全部 19 个文件缺少 Apache 2.0 许可证头（Apache 项目硬性要求）。同时 PR 描述为模板化占位符 "Fixes # (issue)"，无具体 issue 关联和变更动机说明，违反 Apache 社区贡献规范。.agents/ 目录命名（点号前缀）可能被 .gitignore 排除，需确认或改用 agents/ 目录名。
P1 × 4：Go 版本号可疑（1.25.0）、目录路径引用有误（filter/otel/ → otel/）、协议列表不准确（HTTP/3）、cluster 策略列表不完整
P2 × 3：domain SKILL.md 与 project-rules.md 内容大量重复、runtime 术语与代码组织不对应、工具流程图过于简略
改进优先级：
- 为全部 19 个文件添加 Apache 2.0 许可证头
- 重写 PR 描述，关联 issue，说明变更动机
- 确认 .agents/ 目录不被 .gitignore 排除
- 逐项核实文档中的代码路径、API 签名、Go 版本号
- 消除 domain SKILL.md 与 project-rules.md 的内容重复
|
This pr is by the https://github.com/Tsukikage7/dubbo-go-skills version update.
|
|
我的意思是把有参考文档的这个事情写在skills里面 不过你这个pr加了就加了吧，也挺好的 |
There was a problem hiding this comment.
只保留Tell Codex: 剩下的删掉?
There was a problem hiding this comment.
我晕了 I have fixed it.
There was a problem hiding this comment.
我觉得无论是面向用户的还是面向agents这个文档都没啥用呀
| Checklist: | ||
| - [ ] Provider started successfully? Look for `dubbo server started` and `A provider service ... was registered successfully` in provider logs. | ||
| - [ ] Same registry address on both sides (`dubbo.WithRegistry(registry.WithAddress(...))` / YAML `dubbo.registries.xxx.address`)? | ||
| - [ ] Same application name on both sides (`dubbo.WithName(...)`)? v3 defaults to **application-level** discovery — the registry stores the app name, not the interface FQN. | ||
| - [ ] Same `interface` name passed to `pb.RegisterXxxHandler` and `pb.NewXxxService`? | ||
| - [ ] Same protocol on both sides (both `tri` or both `dubbo`)? | ||
| - [ ] Provider visible in the registry? |
There was a problem hiding this comment.
这里加一种情况：是否是同一等级的服务发现，dubbo-go最新版默认使用应用级服务发现，老版本默认使用接口级服务发现，这两者并不互通
| - [ ] Protobuf: same `.proto` compiled on both sides? Same `go_package`? | ||
| - [ ] Hessian2: POJO `JavaClassName()` matches the Java class FQN exactly? `RegisterPOJO` called in an `init()` that actually runs? | ||
|
|
||
| For Hessian2 specifics, see `dubbo-go-java-interop`. |
| **Cause**: Filter imported but `init()` not registered, or name mismatch between `extension.SetFilter` and `WithFilter`. | ||
|
|
||
| Checklist: | ||
| - [ ] Blank import present? e.g. `_ "dubbo.apache.org/dubbo-go/v3/filter/token"` or `_ "github.com/yourorg/yourapp/filter/myfilter"` |
There was a problem hiding this comment.
这里加一个例子_ "github.com/apache/dubbo-go-extensions/filter/hystrix"
| For graceful shutdown: | ||
| ```go | ||
| import _ "dubbo.apache.org/dubbo-go/v3/graceful_shutdown" | ||
| ``` |
There was a problem hiding this comment.
直接让llm读dubbo-go-samples的readme不就完了，这个samples可能还会更新呢
|
Description
Fixes # (issue)
Checklist
develop