Skip to content

docs: PI 2.4 : group 字段#1195

Merged
MistEO merged 4 commits intomainfrom
docs/PI_2.4
Mar 11, 2026
Merged

docs: PI 2.4 : group 字段#1195
MistEO merged 4 commits intomainfrom
docs/PI_2.4

Conversation

@MistEO
Copy link
Copy Markdown
Member

@MistEO MistEO commented Mar 9, 2026

@MaaXYZ/ui-developers @MaaXYZ/application-developers

Summary by Sourcery

在 Project Interface 规范中新增任务分组支持,并在 schema 中进行校验。

新功能:

  • interface.json 中通过 group 字段引入顶层任务分组声明。
  • 允许任务通过 task.group 字段声明其隶属于一个或多个分组。
  • 在 PI 导入中,支持与 tasks、options 和 presets 一起导入 group 定义。

增强:

  • 扩展 interface schema,以在 PI 配置中校验新的 grouptask.group 字段。

文档:

  • 更新英文和中文的 Project Interface v2 文档,描述任务分组、其字段、使用示例,以及新的 v2.4.0 更新日志条目。
Original summary in English

Summary by Sourcery

Add task grouping support to the Project Interface spec and validate it in the schema.

New Features:

  • Introduce top-level task group declarations via the group field in interface.json.
  • Allow tasks to declare membership in one or more groups via the task.group field.
  • Support importing group definitions alongside tasks, options, and presets in PI imports.

Enhancements:

  • Extend the interface schema to validate the new group and task.group fields in PI configurations.

Documentation:

  • Update English and Chinese Project Interface v2 documentation to describe task groups, their fields, usage examples, and the new v2.4.0 changelog entry.

新功能:

  • interface.json 中引入顶层分组声明,用于定义任务分组及其展示属性。
  • 允许任务通过 task.group 字段声明其属于一个或多个分组。
  • 支持导入流程在引入任务、选项和预设配置的同时导入分组定义。

增强:

  • 更新 interface schema,以在 PI 配置中校验新的 grouptask.group 字段。

文档:

  • 扩展英文和中文的 Project Interface v2 文档,加入关于 grouptask.group 字段的说明与示例,包括针对 v2.4.0 的版本说明。
Original summary in English

Summary by Sourcery

在 Project Interface 规范中新增任务分组支持,并在 schema 中进行校验。

新功能:

  • interface.json 中通过 group 字段引入顶层任务分组声明。
  • 允许任务通过 task.group 字段声明其隶属于一个或多个分组。
  • 在 PI 导入中,支持与 tasks、options 和 presets 一起导入 group 定义。

增强:

  • 扩展 interface schema,以在 PI 配置中校验新的 grouptask.group 字段。

文档:

  • 更新英文和中文的 Project Interface v2 文档,描述任务分组、其字段、使用示例,以及新的 v2.4.0 更新日志条目。
Original summary in English

Summary by Sourcery

Add task grouping support to the Project Interface spec and validate it in the schema.

New Features:

  • Introduce top-level task group declarations via the group field in interface.json.
  • Allow tasks to declare membership in one or more groups via the task.group field.
  • Support importing group definitions alongside tasks, options, and presets in PI imports.

Enhancements:

  • Extend the interface schema to validate the new group and task.group fields in PI configurations.

Documentation:

  • Update English and Chinese Project Interface v2 documentation to describe task groups, their fields, usage examples, and the new v2.4.0 changelog entry.

@MistEO MistEO marked this pull request as ready for review March 9, 2026 14:08
Copilot AI review requested due to automatic review settings March 9, 2026 14:08
@MistEO MistEO changed the title docs: PI group 字段 docs: PI 2.4 : group 字段 Mar 9, 2026
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 - 我在这里给出了一些高层次的反馈:

  • 对于新的顶层 group 字段,建议补充文档说明导入的 group 定义是如何进行合并的(例如,后导入的是否会按 name 覆盖先导入的,是否允许重复,以及冲突时如何处理),类似于通常描述任务合并语义的方式。
  • task.group 小节可以明确说明:如果它引用了一个在顶层 group 数组中未定义的 name 会发生什么(忽略、报错还是给出警告),这样客户端和 PI 作者就能有一致的预期。
面向 AI 代理的提示词
请解决本次代码评审中的所有评论:

## 整体意见
- 对于新的顶层 `group` 字段,建议补充文档说明导入的 `group` 定义是如何进行合并的(例如,后导入的是否会按 `name` 覆盖先导入的,是否允许重复,以及冲突时如何处理),类似于通常描述任务合并语义的方式。
- `task.group` 小节可以明确说明:如果它引用了一个在顶层 `group` 数组中未定义的 `name` 会发生什么(忽略、报错还是给出警告),这样客户端和 PI 作者就能有一致的预期。

Sourcery 对开源项目免费——如果你觉得我们的评审有帮助,欢迎分享 ✨
帮我变得更有用!请对每条评论点 👍 或 👎,我会根据这些反馈改进后续的评审。
Original comment in English

Hey - I've left some high level feedback:

  • For the new top-level group field, it would help to document how imported group definitions are merged (e.g., whether later imports override earlier ones by name, whether duplicates are allowed, and how conflicts are resolved), similar to how task merging semantics are typically described.
  • The task.group section could explicitly clarify what happens if it references a name that is not defined in the top-level group array (ignored, error, or warning), so client and PI authors have consistent expectations.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- For the new top-level `group` field, it would help to document how imported `group` definitions are merged (e.g., whether later imports override earlier ones by `name`, whether duplicates are allowed, and how conflicts are resolved), similar to how task merging semantics are typically described.
- The `task.group` section could explicitly clarify what happens if it references a `name` that is not defined in the top-level `group` array (ignored, error, or warning), so client and PI authors have consistent expectations.

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.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR documents Project Interface (PI) v2 task grouping by adding schema support for top-level group declarations and per-task task.group, and updating the English PI v2 documentation/version notes accordingly.

Changes:

  • Extend tools/interface.schema.json with groupItem, top-level group, and task.group fields; update import field description to mention importing group.
  • Update docs/en_us/3.3-ProjectInterfaceV2.md to add v2.4.0 version note and document group / task.group with examples.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
tools/interface.schema.json Adds schema definitions/properties for task grouping and updates import description text.
docs/en_us/3.3-ProjectInterfaceV2.md Documents v2.4.0 task grouping fields and updates the version history table.

@MistEO MistEO merged commit 54b0f71 into main Mar 11, 2026
1 check passed
@MistEO MistEO deleted the docs/PI_2.4 branch March 11, 2026 05:35
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