Skip to content

feat: add Treeland QtWayland scanner agent skill - #1290

Open
zzxyb wants to merge 1 commit into
linuxdeepin:masterfrom
zzxyb:ai
Open

feat: add Treeland QtWayland scanner agent skill#1290
zzxyb wants to merge 1 commit into
linuxdeepin:masterfrom
zzxyb:ai

Conversation

@zzxyb

@zzxyb zzxyb commented Aug 17, 2026

Copy link
Copy Markdown
Collaborator

Added an agent skill for maintaining and reviewing Treeland's Qt-style Wayland protocol scanner and its build integration.

The implementation includes:

  1. Documented the server-side protocol generation pipeline
  2. Added guidance for scanner semantics and command-line compatibility
  3. Covered native-tool handling during cross-compilation
  4. Added targeted build and generated-output validation workflows
  5. Added agent metadata for skill discovery and invocation

Log: Added Treeland QtWayland scanner maintenance skill Influence:

Summary by Sourcery

Add an agent skill and supporting documentation for maintaining and validating Treeland's Qt-style Wayland protocol scanner and its build integration.

New Features:

  • Introduce a Treeland QtWayland scanner maintenance skill for the agent framework, covering generator behavior and build integration.

Documentation:

  • Add detailed SKILL documentation describing scope, generation pipeline, semantics, command-line contract, CMake/cross-compilation behavior, workflow, validation, and review checklist for the Treeland Qt-style Wayland scanner.

@zzxyb
zzxyb requested a review from zccrs August 17, 2026 09:37

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Sorry @zzxyb, you have reached your weekly rate limit of 500000 diff characters.

Please try again later or upgrade to continue using Sourcery

@zzxyb zzxyb added the documentation Improvements or additions to documentation label Aug 17, 2026
@deepin-ci-robot

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: zzxyb

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@sourcery-ai

sourcery-ai Bot commented Aug 17, 2026

Copy link
Copy Markdown

Reviewer's Guide

Adds a new Treeland QtWayland scanner maintenance agent skill, documenting the scanner’s generation pipeline, semantics, cross-compilation behavior, and validation workflow, and exposes it via OpenAI agent metadata for discovery and usage.

Flow diagram for Treeland QtWayland server protocol generation pipeline

flowchart TD
  A[local_qtwayland_server_protocol_treeland]
  B[Resolve PROTOCOL XML path]
  C[wayland-scanner
  wayland-<basename>-server-protocol.h/.c]
  D[qtwaylandscanner_treeland server-header
  qwayland-server-<basename>.h]
  E[qtwaylandscanner_treeland server-code
  qwayland-server-<basename>.cpp]
  F[Target consuming generated Qt code]

  A --> B --> C --> D --> E --> F

  C -->|stdout C output| D
  D -->|stdout header| E
  E -->|add generated cpp to target| F
Loading

File-Level Changes

Change Details Files
Introduce a dedicated skill guide for maintaining and reviewing Treeland’s Qt-style Wayland scanner and its build/CMake integration.
  • Describe scope and primary source/build files involved in the scanner and protocol generation.
  • Define routing rules between scanner, private protocol, upstream protocol, and logging skills.
  • Document the server-side generation pipeline from Wayland XML to C and Qt-style C++ outputs.
  • Specify generator semantics for XML parsing, type mapping, signature generation, and compatibility-sensitive cases.
  • Codify the command-line contract including supported modes and options, and error-handling expectations.
  • Detail CMake integration requirements, including native-tool handling for cross-compilation and custom-command behavior.
  • Provide workflow and validation steps plus a review checklist for future changes to the scanner and its integration.
.agents/skills/qtwayland-scanner-treeland/SKILL.md
Register the new scanner skill as an invocable agent via OpenAI metadata.
  • Define a human-facing display name for the Treeland QtWayland scanner skill.
  • Add a short description explaining its purpose around Qt-style Wayland code generation.
  • Set a default prompt that instructs the agent to use the scanner skill for updating and validating protocol generation.
.agents/skills/qtwayland-scanner-treeland/agents/openai.yaml

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

Added an agent skill for maintaining and reviewing Treeland's
Qt-style Wayland protocol scanner and its build integration.

The implementation includes:
1. Documented the server-side protocol generation pipeline
2. Added guidance for scanner semantics and command-line compatibility
3. Covered native-tool handling during cross-compilation
4. Added targeted build and generated-output validation workflows
5. Added agent metadata for skill discovery and invocation

Log: Added Treeland QtWayland scanner maintenance skill
Influence:

Copilot AI 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.

Pull request overview

EN: This PR adds a new agent skill document to guide maintenance/review of Treeland’s in-tree Qt-style Wayland protocol scanner (qtwaylandscanner_treeland) and its CMake-based generation pipeline, including cross-compilation considerations.

中文:本 PR 新增一个 Agent Skill 文档,用于指导 Treeland 内置的 Qt 风格 Wayland 协议扫描/生成器(qtwaylandscanner_treeland)及其 CMake 生成流水线的维护与评审,并覆盖交叉编译场景的注意事项。

Changes:

  • EN: Add a dedicated skill with scope, routing guidance, and a generation pipeline description.
    中文:新增独立 skill,明确适用范围、任务路由与生成流水线说明。
  • EN: Document scanner semantics/CLI contract and cross-compilation (native-tool) handling.
    中文:补充扫描器语义/命令行契约与交叉编译下 native tool 处理指引。
  • EN: Provide workflow/validation steps and a review checklist for safe updates.
    中文:提供工作流/验证步骤与评审清单,降低修改风险。
Suppressed comments (1)

.agents/skills/qtwayland-scanner-treeland/SKILL.md:134

  • EN: In the bash snippet, generate_protocols_libtreeland_<basename> is not safe to copy/paste: <basename> will be parsed by the shell as stdin redirection. Use a placeholder without angle brackets.

中文:bash 示例里的 generate_protocols_libtreeland_<basename> 不适合直接复制粘贴:<basename> 会被 shell 当成输入重定向。建议改用不带尖括号的占位符。

cmake --build build --target qtwaylandscanner_treeland
cmake --build build --target generate_protocols_libtreeland_<basename>
cmake --build build --target libtreeland

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .agents/skills/qtwayland-scanner-treeland/SKILL.md
@@ -0,0 +1,169 @@
---
name: qtwayland-scanner-treeland

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

treeland-private-wayland-protocol 区别是什么?

@deepin-bot

deepin-bot Bot commented Aug 21, 2026

Copy link
Copy Markdown

TAG Bot

New tag: 0.9.0
DISTRIBUTION: unstable
Suggest: synchronizing this PR through rebase #1312

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants