MaaNTE Documentation

MaaNTE Team

PR 规范

约 1278 字大约 4 分钟

本文档用于说明 MaaNTE 项目的 Pull Request（PR）提交、描述、验证与评审要求。提交 PR 前，请先阅读快速开始与编码规范。

基本原则

目标分支：所有功能、修复与文档 PR 默认提交到 dev 分支。
小步提交：一个 PR 只解决一个明确问题，避免把无关重构、格式化和功能改动混在一起。
尽早 Draft：需求尚未完全确定、实现还在探索时，请先创建 Draft PR，方便维护者提前发现方向问题。
先同步上游：提交评审前 rebase 或 merge 最新 origin/dev，减少重复冲突。
自己负责：可以使用 AI 辅助，但提交者必须理解并能解释 PR 中的每一处关键改动。

分支与提交

分支命名

推荐使用以下格式：

类型	示例	适用场景
`feat/<name>`	`feat/touch-animal`	新增任务或功能
`fix/<name>`	`fix/fish-sell-stuck`	修复 Bug
`docs/<name>`	`docs/pr-guidelines`	文档改动
`refactor/<name>`	`refactor/scene-manager`	不改变行为的结构调整
`chore/<name>`	`chore/update-deps`	工具、依赖、构建等维护工作

提交信息

提交信息遵循约定式提交（Conventional Commits）：

<type>(<scope>): <subject>

示例：

feat(Touch): 添加自动抚摸任务
fix(FishNew): 修复无鱼饵时卖鱼流程卡住
docs: 补充 PR 规范

scope 可选，建议填写任务名、模块名或影响范围。subject 使用简短中文描述，不以句号结尾。

PR 标题

PR 标题同样使用约定式提交格式，便于维护者快速判断变更类型：

推荐标题	不推荐标题
`feat(Touch): 添加自动抚摸任务`	`添加新功能`
`fix(FishNew): 修复卖鱼流程卡住`	`修一下鱼`
`docs: 补充 Pipeline 调试说明`	`update docs`

如果 PR 仍在开发中，请使用 GitHub Draft PR，而不是在标题前长期保留 WIP。

PR 描述

PR 描述至少应包含以下信息：

关联内容

关联 Issue：Closes #123、Fixes #123 或 Related #123
如果没有 Issue，请说明需求来源、复现方式或为什么需要这个改动

变更摘要

用 2～5 条 bullet 说明改了什么，例如：

新增 Touch 任务入口与任务配置
新增 TouchDetect / TouchPressF 等 Pipeline 节点
补充界面文案与文档说明

验证记录

说明你做过哪些验证。不要只写“已测试”，应写清楚测试入口、设备/控制器、结论。

推荐格式：

## 验证

- [x] 使用 Maa Pipeline Support 测试 `TouchDetect`，可稳定识别 1280×720 截图
- [x] 使用 Win32-Front 控制器完整运行 `Touch` 任务 3 次，均正常结束
- [x] 检查新增任务已在 `assets/interface.json` 注册