开发前须知

约 948 字大约 3 分钟

提示

只有当您想要开发 M9A 时才需要看当前页面！用户请转到 M9A 使用手册开发 MaaFramework 或开发自己的项目请到 MaaXYZ/MaaFramework

Github Pull Request 流程简述

我不懂编程，只是想改一点点 JSON 文件/文档等，要怎么操作？

欢迎收看牛牛也能看懂的 GitHub Pull Request 使用指南

我有编程经验，但是没参与过相关项目，要怎么做？

如果很久以前 fork 过，先在自己仓库的 Settings 里，翻到最下面，删除
打开 M9A 主仓库，点击 Fork，继续点击 Create fork
克隆你自己的仓库到本地，并拉取子模块
```
git clone --recursive https://github.com/<你的用户名>/M9A.git
```
注意
--recursive 一定不要忘！--recursive 一定不要忘！--recursive 一定不要忘！
OCR异常失败很可能就是没加recursive导致
如已克隆但发现资源缺失，可运行：
```
git submodule update --init --recursive
```
下载 MaaFramework 的 Release 包，解压到 deps 文件夹中。
提示
目前可跳过这步，仅在需要本地测试命令行版本时执行

配置编程环境

安装 python（≥3.11）
下载并安装vscode

选择性安装调试/开发工具

工具	简介
MaaDebugger	独立调试工具
Maa Pipeline Support	VSCode 插件，提供调试、截图、获取 ROI 、取色等功能
MFAToolsPlus	跨平台开发工具箱，提供便捷的数据获取和模拟测试方法
ImageCropper(不推荐)	独立截图及获取 ROI 工具
MaaLogAnalyzer	可视化分析基于 MaaFramework 开发应用的日志

提示

推荐使用 VSCode 插件进行开发调试、MaaLogAnalyzer 进行用户日志分析

开始开发
在项目的根目录运行 python ./tools/ci/configure.py 配置OCR模型。
使用上一个步骤中安装的调试/开发工具开发M9A，虚拟环境会自动创建在.venv目录中。
开始愉快的改代码吧，可以看看别的文档。
git 操作
通常用的最多的基本命令有：
- git add <file>：添加文件到暂存区，* 代表全部文件
- git commit -m "message"：提交暂存区到本地仓库。message 请遵循约定式提交规范，让你的 commit 信息更加清晰
- git pull origin <branch>：拉取远程仓库到本地仓库
- git push origin <branch>：推送本地仓库到远程仓库
注意
开发过程中，每一定数量，记得提交一个 commit, 别忘了写上 message 假如你不熟悉 git 的使用，你可能需要创建并切换到一个新的分支，而不是直接提交在 main 上这样你的提交就能在新的分支上生长，不会受到 main 更新的打扰
```
git checkout -b <branch-name> # 创建并切换到新的分支
```
完成开发后，推送你修改的本地分支到远程仓库（fork 的仓库）
```
git push origin <branch-name>
```
当 M9A 仓库出现更改（如其他人的commit），你可能需要把这些更改同步到你的分支
1. 关联 M9A 原仓库：
```
git remote add upstream https://github.com/MAA1999/M9A.git
```
2. 拉取远程仓库更新：
```
git fetch upstream
```
3. 变基（推荐）或者合并修改：
```
git rebase upstream/main # 变基，使commit历史更清晰，完成你的个人pr时建议使用rebase而不是merge来合并修改
```
  或者
```
git merge upstream/main
```
git 参考资料：
提交 Pull Request
你修改的代码已经提交到你的仓库，现在你需要提交一个 Pull Request 到 M9A 的仓库，等待维护者审核
GitHub Pull Request 参考