mirror of
https://github.com/zyycn/codex-proxy-rs.git
synced 2026-11-06 08:06:19 +00:00
chore(plugins): update examples and require official source references
Advance plugin examples to v0.1.17 and clarify source priorities for plugin development. Co-authored-by: Codex <noreply@openai.com>
This commit is contained in:
@@ -23,13 +23,21 @@ description: 开发、排查和打包 Codex Proxy RS 网关插件。用户说“
|
||||
|
||||
## 开始工作
|
||||
|
||||
1. 确认插件用途、已有工程/输出目录、目标宿主版本与平台。已有项目沿用其结构;没有指定工程时先确认目录,不把插件源码塞进宿主 workspace
|
||||
1. 确认插件用途、已有工程/输出目录、目标宿主版本与平台。涉及上游协议或客户端兼容时,先按下节核实行为与方案依据。已有项目沿用其结构;没有指定工程时先确认目录,不把插件源码塞进宿主 workspace
|
||||
2. 先读 [SDK 入口](../../../backend/crates/gateway-plugin/sdk/README.md) 和[清单](../../../backend/crates/gateway-plugin/sdk/docs/manifest.md),再按下表只选本次需要的能力章节
|
||||
3. 核对实际运行宿主的版本、目标版本的 [SDK Cargo.toml](../../../backend/crates/gateway-plugin/sdk/Cargo.toml) 与[宿主支持清单](../../../backend/crates/gateway-plugin/runtime/plugin-host-compatibility.json)。同时确认打包 CLI 使用相同作者清单合同;不要只看源码版本或依赖包版本号。清单版本、通信版本、能力版本各自独立
|
||||
4. 需要构建、联调或交付时读取 [构建与验证](references/development.md),先检查实际依赖和脚本,不假设包已公开发布;通过 GitHub 交付时另读其中的[发布与安装来源](references/development.md#发布与安装来源)
|
||||
|
||||
本技能相对链接以各文件所在目录解析;主仓根目录是本文件所在目录向上三级。插件工程或同级示例不在磁盘上时,请用户提供位置或使用选定版本的公开资料,不猜开发机绝对路径,也不自动克隆或创建远程仓库。
|
||||
|
||||
## 上游行为与方案依据
|
||||
|
||||
执行 [问题与方案依据](../../../CONTRIBUTING.md#问题与方案依据),并区分资料的用途:
|
||||
|
||||
- **Codex 上游行为:** 以 [OpenAI Codex 官方源码](https://github.com/openai/codex) 为首要资料,优先读取用户提供或本机已有的官方仓库,核对来源、版本或提交及相关调用链;不足时查官方对应版本源码,结合官方测试、文档与运行证据。源码不可得或版本不匹配时明确证据缺口,不用第三方实现代替官方合同。
|
||||
- **CPR 插件能力:** 以目标宿主版本的公开 SDK、宿主源码与能力合同判断能否复用;官方已有处理路径时,先核对插件是否只需正确传递参数或组合现有能力。偏离官方路径须说明宿主的实际约束,并验证相应行为。
|
||||
- **第三方中转项目:** sub2api、new-api 等源码可用于核对其转发请求、定位链路差异和寻找实现线索,不能直接据此认定 Codex 的协议、会话或工具行为,也不能仅因第三方采用某种方案就照搬为官方示例。交付时区分官方依据、第三方观察与本项目实测结论。
|
||||
|
||||
## 按任务选择能力
|
||||
|
||||
| 用户要做什么 | 优先使用 | 需要读取的合同 |
|
||||
|
||||
+1
-1
Submodule modules/plugins updated: a5abda05be...f913c99d5e
Reference in New Issue
Block a user