Merged
Conversation
Contributor
There was a problem hiding this comment.
Hey - 我在这里给出了一些高层次的反馈:
- 对于新的顶层
group字段,建议补充文档说明导入的group定义是如何进行合并的(例如,后导入的是否会按name覆盖先导入的,是否允许重复,以及冲突时如何处理),类似于通常描述任务合并语义的方式。 task.group小节可以明确说明:如果它引用了一个在顶层group数组中未定义的name会发生什么(忽略、报错还是给出警告),这样客户端和 PI 作者就能有一致的预期。
面向 AI 代理的提示词
请解决本次代码评审中的所有评论:
## 整体意见
- 对于新的顶层 `group` 字段,建议补充文档说明导入的 `group` 定义是如何进行合并的(例如,后导入的是否会按 `name` 覆盖先导入的,是否允许重复,以及冲突时如何处理),类似于通常描述任务合并语义的方式。
- `task.group` 小节可以明确说明:如果它引用了一个在顶层 `group` 数组中未定义的 `name` 会发生什么(忽略、报错还是给出警告),这样客户端和 PI 作者就能有一致的预期。帮我变得更有用!请对每条评论点 👍 或 👎,我会根据这些反馈改进后续的评审。
Original comment in English
Hey - I've left some high level feedback:
- For the new top-level
groupfield, it would help to document how importedgroupdefinitions are merged (e.g., whether later imports override earlier ones byname, whether duplicates are allowed, and how conflicts are resolved), similar to how task merging semantics are typically described. - The
task.groupsection could explicitly clarify what happens if it references anamethat is not defined in the top-levelgrouparray (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.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Contributor
There was a problem hiding this comment.
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.jsonwithgroupItem, top-levelgroup, andtask.groupfields; updateimportfield description to mention importinggroup. - Update
docs/en_us/3.3-ProjectInterfaceV2.mdto add v2.4.0 version note and documentgroup/task.groupwith 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
@MaaXYZ/ui-developers @MaaXYZ/application-developers
Summary by Sourcery
在 Project Interface 规范中新增任务分组支持,并在 schema 中进行校验。
新功能:
interface.json中通过group字段引入顶层任务分组声明。task.group字段声明其隶属于一个或多个分组。group定义。增强:
group和task.group字段。文档:
Original summary in English
Summary by Sourcery
Add task grouping support to the Project Interface spec and validate it in the schema.
New Features:
groupfield ininterface.json.task.groupfield.groupdefinitions alongside tasks, options, and presets in PI imports.Enhancements:
groupandtask.groupfields in PI configurations.Documentation:
新功能:
interface.json中引入顶层分组声明,用于定义任务分组及其展示属性。task.group字段声明其属于一个或多个分组。增强:
group和task.group字段。文档:
group和task.group字段的说明与示例,包括针对 v2.4.0 的版本说明。Original summary in English
Summary by Sourcery
在 Project Interface 规范中新增任务分组支持,并在 schema 中进行校验。
新功能:
interface.json中通过group字段引入顶层任务分组声明。task.group字段声明其隶属于一个或多个分组。group定义。增强:
group和task.group字段。文档:
Original summary in English
Summary by Sourcery
Add task grouping support to the Project Interface spec and validate it in the schema.
New Features:
groupfield ininterface.json.task.groupfield.groupdefinitions alongside tasks, options, and presets in PI imports.Enhancements:
groupandtask.groupfields in PI configurations.Documentation: