Skip to content

Add collaboration guide for third-parties#131

Merged
xijing21 merged 1 commit intoruyisdk:mainfrom
xen0n:3rdparty-collab
Feb 10, 2026
Merged

Add collaboration guide for third-parties#131
xijing21 merged 1 commit intoruyisdk:mainfrom
xen0n:3rdparty-collab

Conversation

@xen0n
Copy link
Copy Markdown
Contributor

@xen0n xen0n commented Feb 9, 2026

Summary by Sourcery

Documentation:

  • Document supported collaboration models for third-party integration with RuyiSDK, including source-based and binary package integration options.

Signed-off-by: WANG Xuerui <git@xen0n.name>
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Feb 9, 2026

Reviewer's Guide

Adds a new Chinese-language documentation page describing collaboration models for third parties integrating with RuyiSDK, covering both source-based and binary-based integration and distribution flows.

Flow diagram for source-based third-party integration with RuyiSDK

flowchart TD
  ThirdParty[第三方项目] -->|提供源码| SourceCode[软件包源码]
  SourceCode -->|提交/共享给| RuyiTeam[RuyiSDK 团队]
  RuyiTeam -->|构建| BinaryPkg[二进制软件包]
  BinaryPkg -->|上传至| OfficialMirror[RuyiSDK 官方镜像源]
  BinaryPkgDef[软件包定义] -->|维护于| OfficialRepo[RuyiSDK 官方软件源仓库]
  RuyiTeam -->|维护| BinaryPkgDef
  OfficialMirror -->|通过 RuyiSDK 包管理器分发| Users[终端用户]
  OfficialRepo -->|提供元数据给| Users
  ThirdParty -->|提供打包建议与必要信息| RuyiTeam
Loading

File-Level Changes

Change Details Files
Introduce a new documentation page outlining third-party collaboration models with RuyiSDK.
  • Add a new Chinese doc describing how third parties can integrate with RuyiSDK via source code integration.
  • Document an alternative binary-only integration model, including responsibilities for distribution and testing.
  • Describe two distribution options for binary packages: re-hosting on official mirrors or using third-party download links.
  • Clarify technical requirements for third parties hosting their own binaries, including HTTP download behavior and User-Agent of the RuyiSDK package manager.
docs/zh/Other/third-party-collab.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey - I've left some high level feedback:

  • In the markdown bullets, keep formatting consistent by adding spaces around bold text (e.g., 通过 **第三方自有渠道** 分发 to match earlier items) and avoiding mixed styles within the same list.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In the markdown bullets, keep formatting consistent by adding spaces around bold text (e.g., `通过 **第三方自有渠道** 分发` to match earlier items) and avoiding mixed styles within the same list.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@@ -0,0 +1,35 @@
# 第三方接入 RuyiSDK 的合作模式

RuyiSDK 团队欢迎第三方项目寻求接入 RuyiSDK 的生态。我们把目前支持的合作模式列举如下;我们欢迎感兴趣的合作方与我们联系。
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

在公开的给合作伙伴可见的文章中,"第三方"换成“合作伙伴”是不是更加合适些?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

我觉得可能还好吧,还没合作怎么能叫合作伙伴?不过你想改的话可以自己改掉

@xijing21
Copy link
Copy Markdown
Collaborator

先合入,后续再更新维护

@xijing21 xijing21 merged commit cca89b0 into ruyisdk:main Feb 10, 2026
2 checks passed
@xen0n xen0n deleted the 3rdparty-collab branch February 10, 2026 06:37
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.

2 participants