Skip to content

2. 开发文档

DLmaster edited this page Dec 30, 2024 · 5 revisions

说明

这是AUTO_MAA项目开发文档,为本项目开发者提供开发指引,以保证刚接触本项目的开发者能够快速上手,并保持项目开发宗旨与整体风格长期不变。

项目宗旨

本项目服务于拥有复数明日方舟账号的群体,致力于提高代理过程的稳定性,追求软件轻量、稳定、方便。

开发信息

  • Python版本:v3.12.7
  • 依赖文件:requirements.txt
  • 主应用入口文件:main.py
  • 统一版本标识文件:resources\version.json
  • 开发参考信息文档:resources\docs
  • 官方镜像仓库:https://gitee.com/DLmaster_361/AUTO_MAA
  • 打包方法:将app\utils\package.py复制到项目根目录后运行

开发流程

正式开发者

  1. 创建开发分支:从Dev主开发分支创建个人开发分支,将开发任务名称作为分支名称。
  2. 完成开发任务:在个人开发分支完成开发任务,并在统一版本标识文件添加相关更新说明。
  3. 处理合并冲突:若Dev主分支在开发任务完成时发生变动,将Dev分支合并入个人开发分支并对合并后的代码进行测试与适配。
  4. 正式合并分支:确定当前个人开发分支已经合并了最新的Dev分支并完成测试后,以开发任务名称作为提交描述将个人开发分支合并入Dev分支。
  5. 删除个人分支:删除个人开发分支并等待项目组统一推送新版本。

非正式开发者

  1. 创建分支仓库:从主仓库创建个人分支仓库,并基于该分支仓库搭建开发环境。
  2. 完成开发任务:在个人分支仓库完成开发任务,并在统一版本标识文件添加相关更新说明。
  3. 处理合并冲突:若Dev主分支在开发任务完成时发生变动,将Dev分支合并入个人分支并对合并后的代码进行测试与适配。
  4. 正式发起合并:确定当前个人开发分支已经合并了最新的Dev分支并完成测试后,以开发任务名称作为描述,提交将个人分支合并入主仓库Dev分支的合并申请,并在该合并申请下声明所适配的提交名称。
  5. 等待审核通过:在接受审核前,审核人员会给出预计审核时间,若等待较长时间仍没有留言,可以前往官方QQ群提醒项目组。

版本号说明

项目版本号由4个数字组成,以下是各位置数字的含义:

  1. 主版本号:标示项目重大更新,通常在项目主功能发生变化或进行彻底重构后更改。
  2. 次版本号:标示项目较大更新,通常在项目添加大量新功能与特性或部分模块重构后更改。
  3. 小版本号:标示项目常规更新,通常在项目若干新功能稳定成熟后更改。
  4. 开发标识:标示项目开发状态,值为0表示该版本为稳定版,否则表示该版本为测试版,通常在新增功能可用时更改。
  • 注意:当完成任一普通BUG修复后,必须推送新测试版;当MAA发生字段修改后,必须推送新稳定版。只有项目正式开发者有资格推送新版本,非正式开发者pr时请勿修改版本号标识
Clone this wiki locally