|
| 1 | +<!-- |
| 2 | +Licensed to the Apache Software Foundation (ASF) under one or more |
| 3 | +contributor license agreements. See the NOTICE file distributed with |
| 4 | +this work for additional information regarding copyright ownership. |
| 5 | +The ASF licenses this file to You under the Apache License, Version 2.0 |
| 6 | +(the "License"); you may not use this file except in compliance with |
| 7 | +the License. You may obtain a copy of the License at |
| 8 | +
|
| 9 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | +
|
| 11 | +Unless required by applicable law or agreed to in writing, software |
| 12 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | +See the License for the specific language governing permissions and |
| 15 | +limitations under the License. |
| 16 | +--> |
| 17 | + |
| 18 | +# dubbo-go Agent Skills |
| 19 | + |
| 20 | +[English](README.md) | [中文](README_CN.md) |
| 21 | + |
| 22 | +This directory contains AI agent skills bundled with [Apache dubbo-go](https://github.com/apache/dubbo-go). The skills help coding agents work with the dubbo-go repository, dubbo-go v3 applications, examples, extension points, Java interoperability, debugging, and migration tasks. |
| 23 | + |
| 24 | +The package lives under `.agents/` so it can include multi-agent distribution metadata without overwriting dubbo-go repository root files. |
| 25 | + |
| 26 | +> Note: All skills target dubbo-go v3. v1 and v2 are deprecated. |
| 27 | +
|
| 28 | +## Layout |
| 29 | + |
| 30 | +- `skills/`: Codex-compatible skills. Codex reads this directory when working in this repository. |
| 31 | +- `.codex/INSTALL.md`: manual Codex installation notes for using these skills outside this checkout. |
| 32 | +- `.claude-plugin/marketplace.json`: Claude Code plugin marketplace metadata for this `.agents` package. |
| 33 | +- `.opencode/plugins/dubbo-go-agent-skills.js`: OpenCode adapter that exposes the bundled skills. |
| 34 | +- `GEMINI.md` and `gemini-extension.json`: Gemini CLI extension entry points. |
| 35 | +- `plugin.json` and `package.json`: generic plugin/package metadata for tools that can consume a package rooted at `.agents`. |
| 36 | + |
| 37 | +## Using These Skills |
| 38 | + |
| 39 | +When working inside an Apache dubbo-go checkout, Codex can load the repository-local skills from `.agents/skills` directly. No separate clone of a skills repository is required. |
| 40 | + |
| 41 | +For global Codex usage outside this checkout, follow [.codex/INSTALL.md](.codex/INSTALL.md). |
| 42 | + |
| 43 | +For OpenCode, Gemini CLI, or Claude Code packaging, treat `.agents` as the package root. The metadata files in this directory are intentionally relative to `.agents`. |
| 44 | + |
| 45 | +## Skills |
| 46 | + |
| 47 | +### development |
| 48 | + |
| 49 | +Guides agents modifying the apache/dubbo-go repository itself. It covers current Go/toolchain expectations, package boundaries, validation commands, generated files, and repository-specific do-not rules. |
| 50 | + |
| 51 | +### scaffolding |
| 52 | + |
| 53 | +Generates provider or consumer skeletons in the current dubbo-go v3 code-API style. It covers direct mode, registry-backed services, Protobuf generation, OpenAPI, HTTP handler mounting, HTTP/3, and current sample patterns. |
| 54 | + |
| 55 | +### extensions |
| 56 | + |
| 57 | +Guides custom SPI extensions such as Filter, LoadBalance, Router, Registry, Protocol, ConfigCenter, and Logger. It covers the `extension.SetXxx` registration pattern, blank imports, activation options, and common failure modes. |
| 58 | + |
| 59 | +### java-interop |
| 60 | + |
| 61 | +Guides interoperability between dubbo-go and dubbo-java. It helps choose Triple+Protobuf or Dubbo+Hessian2, handle service discovery mapping, and debug cross-language serialization. |
| 62 | + |
| 63 | +### debug |
| 64 | + |
| 65 | +Provides structured diagnosis for runtime issues such as missing providers, registry mapping, connection failures, serialization mismatches, timeouts, OpenAPI issues, attached HTTP handlers, shutdown behavior, and filter panics. |
| 66 | + |
| 67 | +### guide |
| 68 | + |
| 69 | +Explains current dubbo-go architecture, extension points, and best practices. It covers Instance, Protocol, Registry, Metadata, Filter, Cluster, LoadBalance, Router, Triple OpenAPI, HTTP/3, CORS, graceful shutdown, observability, and sample locations. |
| 70 | + |
| 71 | +### migrate |
| 72 | + |
| 73 | +Guides migration from gRPC-Go, Spring Cloud, Gin/plain HTTP, older dubbo-go v1/v2 usage, YAML-heavy apps, Java Dubbo, and Hessian2 services to current dubbo-go v3 patterns. |
| 74 | + |
| 75 | +## Contributing |
| 76 | + |
| 77 | +Skills live in `.agents/skills`. |
| 78 | + |
| 79 | +1. Add or edit a skill under `.agents/skills/<name>/SKILL.md`. |
| 80 | +2. Keep `SKILL.md` frontmatter concise and trigger-focused. |
| 81 | +3. Update this directory's metadata only when install paths, skill names, or supported agents change. |
| 82 | +4. Submit the change through the normal dubbo-go contribution workflow. |
| 83 | + |
| 84 | +## License |
| 85 | + |
| 86 | +Apache License 2.0 |
0 commit comments