协作开发指南
开发环境的配置
环境是Eclipse, JDK 21, Git, Maven。
以上软件下载官网最新版本即可。
通过Git拉取分支到本地,创建本地的一个分支(git的使用后面有写),按照自己的分工进行开发。开发完毕后push自己的分支,合并到master分支中。
Git拉取的时候整个项目就会下载下来了,把下载下来的项目导入Eclipse。
导入项目以后,Maven会自动下载依赖包,如果报错,耐心等待下载完成(大概需要几十分钟),下载完成后错误就会消失。
项目的结构
src/main/java
文件夹里是后端的Java代码:分别是主程序,MVC的模型,视图,控制器。
src/main/resources
文件夹里是前端代码:static
文件夹里是CSS和JS文件,templates
文件夹里是HTML文件。
application.properties
是Spring Boot的配置文件,这里用不到。
这三个文件夹里的内容都用不到。
src
文件夹里包含了前面的后端和前端代码。由于Eclipse显示项目结构的方式,代码文件夹会显示两次,但前后内容是一样的。
target
文件夹不用管,也用不到。
pom.xml
是Maven的配置文件,具体使用方法到需要时再详细介绍。
README.md
是设计文档。
开发时的注意事项
使用增量开发,即不要修改项目里已经有的内容,而是新建文件,进行功能的增加。
例如,假如我要开发一个展示页面,需要写一个CSS文件,我应该新建一个CSS文件,而不是在style.css
里进行修改。
这样做能保证项目的稳定性和可维护性。
git与GitHub
由于我们的项目是私有项目,需要绑定github账户才能操作。在你第一次pull或push命令的时候,git应该会自动提示你绑定。
git的使用
使用Feature Branch Workflow(功能分支工作流),具体的步骤和命令如下:
-
从master分支拉取最新代码:
git checkout master git pull origin master
-
创建并切换到新功能分支:
git checkout -b feature/<你的功能分支名称>
-
在功能分支上进行开发和提交:
git add . git commit -m "描述你的改动"
-
将功能分支推送到远程仓库:
git push origin feature/<你的功能分支名称>
-
创建Pull Request (PR) 并请求代码审查:
- 登录GitHub,找到你的功能分支,点击
Compare & pull request
按钮。 - 填写PR描述,添加审查者,然后创建PR。
- 登录GitHub,找到你的功能分支,点击
-
合并PR到master分支:
- 通过审查后,点击
Merge pull request
按钮将功能分支合并到master分支。 - 合并后删除功能分支:
git branch -d feature/<你的功能分支名称> git push origin --delete feature/<你的功能分支名称>
- 通过审查后,点击
-
同步本地master分支:
git checkout master git pull origin master
这样可以确保每个功能独立开发和合并,避免直接在master分支上进行开发引发的冲突和问题。
标签:指南,pull,git,网站,协作,master,开发,文件夹,分支 From: https://www.cnblogs.com/save-mw/p/18308143