如何提交PR

提交PR规范(确保有node.js环境)

介绍

本项目采用前后端分离方式。其中full-hub 属于后端文件夹,而live-2d 属于前端文件夹

其中核心代码都在live-2d文件夹。后端文件夹负责的只是单纯的将各种服务启动,例如:TTS服务(文本转语音)、ASR(语音转文本) 等。暴露出对应的API端口。让前端代码可以调用。所以主要功能很固定,很少会去修改。

而live-2d文件夹属于真正的核心功能区,下面我会一步一步的指导如何为此项目提交pr,留下印记成为本项目的贡献者

具体操作

首先第一步需要fork 这个项目。这里因为我没法自己fork自己的项目,所以找一个别的项目做示范,看下面的图片 点击+Create a new fork

image

继续点击:create fork

image

这样你的仓库下面就有了项目仓库了

image

接下来将你fork的项目克隆到本地


1.找一个空文件夹打开终端
2.git clone https://github.com/你的github用户名/new-my-neuro.git
3.cd new-my-neuro

创建分支

# 具体分支名可以自己取,例如修Bug可以取名:fix/bug  添加新功能可以:feature/add-new-feature 简单易懂就行 下面是示例
git checkout -b 你的分支名字

部署和修改项目代码

这一步需要简单部署项目,也就是部署好后端和前端。3分钟就能搞定

后端部署

首先是后端部署,我们可以偷懒用云端API 这样就省去了下载各种模型的操作。(因为之前说了,后端代码几乎很少会改。基本都定型了。所以可以偷懒用我提供的云端API)

image


接着需要部署live-2d 也就是前端的环境

前端部署

# 进入live-2d文件夹
cd live-2d
npm install

#然后去live-2d文件夹的子文件夹mcp文件夹里运行
cd mcp
npm install

这样前端的环境也部署好了


打包exe文件

双击live-2d文件夹下面的:一键打包QT.bat

alt text

这一步是打包适合用户操作的UI界面,执行完会在live-2d文件夹生成一个:肥牛.exe 文件

上述操作完成后,就可以开始修改代码加功能、修bug等操作了,如果是增加功能,那一次建议只更改一个功能。不要在一次提交中包含多个功能。这是为了防止后续如果出问题,排查困难。

代码都写完做好后,运行这个指令将更改操作都添加到暂存区

git add .

然后提交 在引号里面简单说一下做了什么

git commit -m "描述你做了什么"

最后推送你的修改

git push origin 你的分支名字

然后来到你的fork的仓库这里,会发现多了一个黄不拉几的提示 这个就代表你成功把修改操作提交到了你fork的仓库中,直接点击这个compare pull request

image

来到了这里后,在红框里面可以写具体做了什么,写好后点击那个 create pull request

image

这样成功的提交pr了

image

恭喜你!接下来就可以等待维护者,也就是我来审查你的提交。如果测试都没有问题就可以合并了。然后就可以成为项目的贡献者了!