Skip to content

docs(adapters): clarify adapter PR boundaries#441

Open
xy200303 wants to merge 1 commit into
TencentCloud:mainfrom
xy200303:feat/platform-gateway-sdk
Open

docs(adapters): clarify adapter PR boundaries#441
xy200303 wants to merge 1 commit into
TencentCloud:mainfrom
xy200303:feat/platform-gateway-sdk

Conversation

@xy200303

@xy200303 xy200303 commented Jul 9, 2026

Copy link
Copy Markdown

Description | 描述

This PR narrows #441 into a documentation-only supplement for the ongoing #235 adapter work.

It adds docs/adapters/contribution-guide.md, which documents review lanes for parallel adapter PRs:

  • shared Gateway client
  • coding-agent adapters
  • MCP bridge
  • Dify/workflow adapters
  • documentation-only PRs

The guide also adds a short review checklist covering session identity, lifecycle hook mapping, Gateway auth, focused tests, and PR body scope notes.

This intentionally does not ship another Gateway SDK implementation, because the reusable Gateway client lane is already covered by #316, while coding-agent and MCP-specific lanes are covered separately by #405 and #372.

Related Issue | 关联 Issue

Related to #235
Complements #316, #405, and #372

Change Type | 修改类型

  • Bug fix | Bug 修复
  • New feature | 新功能
  • Documentation update | 文档更新
  • Code optimization | 代码优化

Self-test Checklist | 自测清单

  • Verified locally | 本地验证通过
  • No existing features affected | 无影响现有功能

Additional Notes | 其他说明

Verification performed:

  • git diff --check

No runtime code changed.

Signed-off-by: xy200303 <3483421977@qq.com>
@xy200303 xy200303 force-pushed the feat/platform-gateway-sdk branch from fd853cd to 78fd7a3 Compare July 9, 2026 08:12
@xy200303 xy200303 changed the title feat(adapters): add Gateway platform SDK docs(adapters): clarify adapter PR boundaries Jul 9, 2026

@YOMXXX YOMXXX left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved as a docs-only supplement for the #235 adapter cleanup.

Verified locally:

  • git diff --check
  • README/README_CN links point to docs/adapters/contribution-guide.md
  • docs/adapters/contribution-guide.md exists

This does not add another adapter implementation; it documents contribution lanes and review boundaries so future #235 adapter PRs can avoid duplicating the shared Gateway client / MCP / coding-agent / Dify scopes.

@Maxwell-Code07

Copy link
Copy Markdown
Collaborator

Thanks for your attention! We will review your code and get back to you as soon as possible per our internal schedule.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants