Skip to content

Revise third-party collaboration guide for RuyiSDK#132

Merged
xijing21 merged 2 commits intoruyisdk:mainfrom
xijing21:main
Feb 13, 2026
Merged

Revise third-party collaboration guide for RuyiSDK#132
xijing21 merged 2 commits intoruyisdk:mainfrom
xijing21:main

Conversation

@xijing21
Copy link
Copy Markdown
Collaborator

@xijing21 xijing21 commented Feb 10, 2026

Updated the document to provide a comprehensive guide on integrating third-party resources with RuyiSDK, including collaboration models and technical requirements.

  1. Terminology refinement: Replaced "third-party" with "partners" to foster a more collaborative tone
  2. System overview: Added comprehensive introduction to RuyiSDK package management architecture with visual diagram
  3. Clarified licensing: Explicitly outlined authorization requirements for different integration models
  4. Streamlined workflow: Introduced direct PR contribution option for partners maintaining self-hosted binaries
  5. Enhanced responsibilities: Added detailed maintenance requirements and lifecycle management guidance for self-hosted distribution partners
  6. Focus specification: Clearly defined RISC-V development focus to ensure relevant resource targeting

Summary by Sourcery

Revise and expand the RuyiSDK partner resource integration guide to clarify collaboration models, responsibilities, and the RISC-V-focused package management architecture.

Documentation:

  • Rewrite the third-party collaboration document into a comprehensive partner resource access guide centered on RISC-V development.
  • Document the RuyiSDK package management architecture with a high-level overview and diagram.
  • Clarify licensing and authorization expectations for source and binary integration models, including redistribution terms.
  • Describe detailed workflows for source integration, binary distribution via RuyiSDK mirrors, and self-hosted distribution with direct PR contributions.
  • Specify maintenance, lifecycle, and availability responsibilities for partners using self-hosted distribution channels.
  • Introduce a structured collaboration process, including issue templates and required technical information for resource onboarding.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Feb 10, 2026

Reviewer's Guide

Rewrites and greatly expands the RuyiSDK third-party collaboration guide into a comprehensive partner-focused RISC-V resource integration manual, adding architecture overview, clearer integration modes, licensing/authorization expectations, and explicit maintenance responsibilities for self-hosted binary distribution.

File-Level Changes

Change Details Files
Retitle and reframe the document from "third-party" collaboration to a partner-focused RuyiSDK ecosystem resource access guide with clarified RISC-V scope.
  • Updated main heading to emphasize RuyiSDK ecosystem resource access rather than generic third-party access.
  • Replaced "第三方" terminology with more collaborative "合作伙伴" language throughout.
  • Added introductory paragraph that positions the guide around co-building the RISC-V development ecosystem and clarifies that resources should be RISC-V–oriented.
docs/zh/Other/third-party-collab.md
Introduce a detailed RuyiSDK package management architecture section including supported platforms and a mermaid diagram.
  • Added a new section describing the RuyiSDK package manager’s purpose, the types of RISC-V resources it targets, and prioritization of RISC-V–specific content.
  • Documented the three core components: client tool, package index repository, and resource mirror service, including supported Linux distros and architectures.
  • Inserted a mermaid diagram illustrating partner integration entry points (source, binary, self-hosted links) and flow through build service, mirrors, and index.
docs/zh/Other/third-party-collab.md
Restructure and expand integration modes into explicit "resource access" models with clearer responsibilities and licensing/authorization requirements.
  • Replaced the previous brief "源码对接" and "二进制包对接" sections with a new "资源接入模式" section that defines source integration and binary distribution modes.
  • For the source integration mode, documented step-by-step collaboration flow, including requirement that partners authorize RuyiSDK to build and redistribute binaries.
  • For the binary distribution mode, split into two sub-options (Ruyi-hosted binaries vs partner-hosted download links), detailing flows, authorization for redistribution, and technical requirements like User-Agent behavior and lack of interactive auth.
docs/zh/Other/third-party-collab.md
Define maintenance and lifecycle responsibilities for partners using self-hosted binary distribution (download-link based model), including PR-based technical contribution path.
  • Added a responsibility checklist for partners in the self-hosted binary scenario, covering link stability, version metadata updates, outage response expectations, compatibility declarations, and minimum maintenance horizon.
  • Clarified that for the self-hosted model, partners are primarily responsible for lifecycle management of binaries and must keep RuyiSDK index data up to date.
  • Documented that technically capable partners can directly submit Pull Requests to the packages-index repository, and recommended automating index updates via CI/CD on new releases.
docs/zh/Other/third-party-collab.md
Add a structured collaboration workflow describing contact, submission, review, and release steps with an Issue template for new resource onboarding.
  • Introduced a "协作流程" section that breaks the process into four stages: initial contact, formal submission, technical alignment/authorization, and integration & release.
  • Provided a detailed Markdown Issue template for resource access applications, including basic info, technical data, mode-specific fields, explicit authorization/maintenance confirmations, and contact info.
  • Clarified expectations around RISC-V relevance checks and licensing/authorization review during technical alignment, and reiterated PR-based contributions for experienced Git users.
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:

  • The document now consistently uses“合作伙伴”but the filename and any existing inbound links still refer to third-party-collab.md; consider aligning the file name and any cross-references to avoid confusion and broken expectations.
  • In the“步骤一:初步联系”section you mention官网联系表单和指定邮箱,但没有提供具体链接或地址; consider adding explicit URLs or mailto links so partners can act directly from this guide.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The document now consistently uses“合作伙伴”but the filename and any existing inbound links still refer to `third-party-collab.md`; consider aligning the file name and any cross-references to avoid confusion and broken expectations.
- In the“步骤一:初步联系”section you mention官网联系表单和指定邮箱,但没有提供具体链接或地址; consider adding explicit URLs or mailto links so partners can act directly from this guide.

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.

Updated the document to provide a comprehensive guide on integrating third-party resources with RuyiSDK, including collaboration models and technical requirements.

Signed-off-by: xijing21 <xijing@iscas.ac.cn>
@YunxiangLuo
Copy link
Copy Markdown

lgtm @xijing21

Signed-off-by: xijing21 <xijing@iscas.ac.cn>
@xijing21 xijing21 merged commit 092e281 into ruyisdk:main Feb 13, 2026
2 checks passed
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