软件开发中的 Pull Request 工作流:逐步指南

news2024/11/18 16:13:28

简介
在软件开发中,Pull Request(PR)是开发者向项目主代码库提交代码更改请求的过程。这种方式促进了代码审查、协作和反馈。在本文中,我们将详细介绍一个典型的 Pull Request 工作流,并解释其命名的原因。


1. 创建分支

在开始新功能开发或修复 bug 之前,您需要从主代码库(通常是 mainmaster)创建一个新分支。这样做可以将您的更改与主代码库隔离,便于管理和追踪。

# 从主分支创建新分支
git checkout -b feature/your-feature-name

2. 开发和提交代码

在新分支上进行开发工作。完成更改后,使用 git addgit commit 将更改提交到本地版本库。

# 添加修改的文件
git add .

# 提交代码并附上描述性信息
git commit -m "Add new feature"

3. 推送分支到远程仓库

在本地提交代码后,需要将分支推送到远程仓库,如 GitHub。这样做是为了让其他团队成员可以访问您的更改并进行审查。

# 将分支推送到远程仓库
git push origin feature/your-feature-name

4. 创建 Pull Request

推送新分支后,您可以使用 GitHub CLI (gh) 工具创建 Pull Request。这样可以直接从命令行完成 PR 的创建,简化流程。

# 创建 Pull Request
gh pr create --title "Add new feature" --body "详细说明更改的目的和背景" --base main

在创建 PR 时,您可以指定标题和描述,并关联相关的 Issue(如:Closes #123)。

Pull Request 命名的原因

“Pull Request”得名于请求项目维护者(审核者)将您的更改从您的分支“拉取”(Pull)到主分支中。这个过程是一个请求,因为合并需要经过代码审查和批准。

5. 代码审查

提交 Pull Request 后,其他开发者会对您的代码进行审查。审查过程包括:

  • 提出建议或优化点。
  • 指出可能的错误或问题。
  • 讨论实现方法或设计考虑。

如果需要更改,您可以在本地修改代码,提交并推送更新。Pull Request 会自动包含这些更新。

# 根据反馈进行修改后再次提交
git add .
git commit -m "Fix code review issues"
git push origin feature/your-feature-name

6. 通过和合并

代码审查通过后,项目维护者或有权限的人会将您的分支合并到主分支。在 GitHub 中,您可以选择不同的合并策略:

  • Merge Commit:保留所有提交历史,创建一个合并提交。
  • Squash and Merge:将所有提交压缩为一个提交,保持主分支整洁。

7. 删除分支

合并后,您可以删除不再需要的功能分支。

# 删除本地分支
git branch -d feature/your-feature-name

# 删除远程分支
git push origin --delete feature/your-feature-name

8. 本地同步主分支

最后,切换回主分支并拉取最新的代码,保持本地仓库的更新。

# 切换回主分支
git checkout main

# 拉取最新的主分支代码
git pull origin main

Pull Request 工作流程图

以下是一个简单的 ASCII 流程图描述 Pull Request 工作流:

+-------------------+     Git Branch 状态:
|   创建新分支      |       main
|   git checkout -b |        \
+---------+---------+         \-- feature/your-feature-name
          |                  
          v                  
+-------------------+    Git Branch 状态:
|   开发和提交代码  |       main
|   git add, commit |        \
+---------+---------+         \-- feature/your-feature-name*
          |                                    (committed changes)
          v                  
+-------------------+     Git Branch 状态:
|   推送到远程仓库  |       main
|   git push origin |        \
+---------+---------+         \-- feature/your-feature-name*
          |                                    (pushed changes)
          v                  
+-------------------+     Git Branch 状态:
| 创建 Pull Request |       main
|   gh pr create    |        \
+---------+---------+         \-- feature/your-feature-name*
          |                                    (PR created)
          v                  
+-------------------+     Git Branch 状态:
|   代码审查        |       main
|   修改后推送更新  |          \
+---------+---------+         \-- feature/your-feature-name*
          |                                    (reviewed and updated)
          v                  
+-------------------+     Git Branch 状态:
|   合并到主分支    |       main (merged)
+---------+---------+        \
          |                   \-- feature/your-feature-name
          v                 
+-------------------+     Git Branch 状态:
|   删除分支        |       main
|   git branch -d   |       
+---------+---------+       
          |                  
          v                  
+-------------------+     Git Branch 状态:
|   同步主分支      |       main*
|   git checkout,   |       
|   git pull        |       
+-------------------+

通过这个工作流,团队成员可以高效协作开发,并确保代码在合并到主分支之前得到充分的审查和讨论。GitHub CLI 工具进一步简化了命令行环境下的操作,使得整个流程更加流畅。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2242906.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

CSS基础知识05(弹性盒子、布局详解,动画,3D转换,calc)

目录 0、弹性盒子、布局 0.1.弹性盒子的基本概念 0.2.弹性盒子的主轴和交叉轴 0.3.弹性盒子的属性 flex-direction row row-reverse column column-reverse flex-wrap nowrap wrap wrap-reverse flex-dirction和flex-wrap的组合简写模式 justify-content flex-s…

【Qt聊天室】客户端实现总结

目录 1. 项目概述 2. 功能实现 2.1 主窗口设计 2.2 功能性窗口 2.3 主界面功能实现 2.4 聊天界面功能实现 2.5 个人信息功能开发 2.6 用户信息界面设置功能 2.7 单聊与群聊 2.8 登录窗口 2.9 消息功能 3. 核心设计逻辑 3.1 核心类 3.2 前后端交互与DataCenter 4…

RK3568平台开发系列讲解(高级字符设备篇)IO 模型引入实验

🚀返回专栏总目录 文章目录 一、IO 的概念二、IO 执行过程三、IO 模型的分类阻塞 IO非阻塞 IOIO 多路复用信号驱动异步 IO沉淀、分享、成长,让自己和他人都能有所收获!😄 一、IO 的概念 IO 是英文 Input 和 Output 的首字母, 代表了输入和输出, 当然这样的描述有一点点…

简单实现QT对象的[json]序列化与反序列化

简单实现QT对象的[json]序列化与反序列化 简介应用场景qt元对象系统思路实现使用方式题外话 简介 众所周知json作为一种轻量级的数据交换格式,在开发中被广泛应用。因此如何方便的将对象数据转为json格式和从json格式中加载数据到对象中就变得尤为重要。 在python类…

【qt】控件2

1.frameGeometry和Geometry区别 frameGeometry是开始从红圈开始算,Geometry从黑圈算 程序证明:使用一个按键,当按键按下,qdebug打印各自左上角的坐标(相当于屏幕左上角),以及窗口大小 Widget::Widget(QWid…

LeetCode654.最大二叉树

LeetCode刷题记录 文章目录 📜题目描述💡解题思路⌨C代码 📜题目描述 给定一个不重复的整数数组 nums 。 最大二叉树 可以用下面的算法从 nums 递归地构建: 创建一个根节点,其值为 nums 中的最大值。 递归地在最大值 左边 的 子…

华为欧拉系统使用U盘制作引导安装华为欧拉操作系统

今天记录一下通过U盘来安装华为欧拉操作系统 华为欧拉操作系统是国产的一个类似于Centos的Linus系统 具体实现操作步骤: 先在官网下载欧拉系统镜像点击跳转到下载 准备好一个大于16g的U盘 ,用于制作U盘启动 下载一个引导程序制作工具,我使用…

软考教材重点内容 信息安全工程师 第 3 章 密码学基本理论

(本章相对老版本极大的简化,所有与算法相关的计算全部删除,因此考试需要了解各个常 用算法的基本参数以及考试中可能存在的古典密码算法的计算,典型的例子是 2021 和 2022 年分别考了 DES 算法中的 S 盒计算,RSA 中的已…

如何让手机ip变成动态

在数字化浪潮中,手机已成为我们日常生活中不可或缺的一部分。无论是浏览网页、使用社交媒体还是进行在线购物,手机都扮演着举足轻重的角色。然而,在享受网络带来的便利时,我们也需要关注网络安全和隐私保护。静态IP地址可能让手机…

64位程序调用32位dll解决方案

最近在做64位代码移植,发现很多老代码使用到了第三方的32位dll;而且这些第三方32位dll库已经年代久远,原开发商已不再了;所以急切的需要在64位主程序 中使用老的32位dll;查询很多解决方案 发现目前只有使用com 进程外组件的方法可以解决此问题…

无人机挂载超细干粉灭火装置技术详解

无人机挂载超细干粉灭火装置技术是一种创新的灭火方式,结合了无人机的远程操控能力和超细干粉灭火剂的高效灭火性能。以下是对该技术的详细解析: 一、技术背景与原理 背景:高层建筑灭火救援困难一直是公认的世界性难题。无人机技术的发展为…

信号-3-信号处理

main 信号捕捉的操作 sigaction struct sigaction OS不允许信号处理方法进行嵌套:某一个信号正在被处理时,OS会自动block改信号,之后会自动恢复 同理,sigaction.sa_mask 为捕捉指定信号后临时屏蔽的表 pending什么时候清零&…

Linux的指令(三)

1.grep指令 功能: 在文件中搜索字符串,将找到的行打印出来 -i:忽略大小写的不同,所以大小写视为一样 -n:顺便输出行号 -v:反向选择,就是显示出没有你输入要搜索内容的内容 代码示例: roo…

onvif协议相关:4.1.7 Digest方式云台控制停止

背景 关于onvif的其实很早之前我已经在专栏中写了不少了, 使用onvif协议操作设备 但最近有陆陆续续的粉丝问我, 希望我在写一些关于 onvif的设备自动发现、预置位跳转、云台操作的博客。 满足粉丝的需求,安排。 今天我们来实现 设备云台的控制(启动) 实现 1.在ONVIF Devi…

【机器学习】数学知识:标准差,方差,协方差,平均数,中位数,众数

标准差、方差和协方差是统计学中重要的概念,用于描述数据的分散程度和变量之间的关系。以下是它们的定义和公式: 1. 标准差 (Standard Deviation) 标准差是方差的平方根,表示数据的分散程度,以与数据相同的单位表示。 公式&…

数据结构习题——有效的括号(栈),栈与队列和互相实现,循环队列的实现

文章目录 前言1、有效的括号题目思路代码 2、用队列实现栈题目思路代码 3、用栈实现对列题目思路代码 4、设计循环队列4.1循环队列的概念和了解题目思路代码 总结 前言 继上篇博客学习了栈与队列之后,今天我们来尝试着使用他们来写一些题目,话不多说&…

Java连接MySQL(测试build path功能)

Java连接MySQL(测试build path功能) 实验说明下载MySQL的驱动jar包连接测试的Java代码 实验说明 要测试该情况,需要先安装好MySQL的环境,其实也可以通过测试最后提示的输出来判断build path是否成功,因为如果不成功会直…

计算机组成原理——高速缓存

标记表示——主存块号和缓存块之前的一一对应关系

Java面试之多线程并发篇(5)

前言 本来想着给自己放松一下,刷刷博客,突然被几道面试题难倒!常用的线程池有哪些?简述一下你对线程池的理解?Java程序是如何执行的?锁的优化机制了解吗?说说进程和线程的区别?似乎…

JavaWeb之AJAX

前言 这一节讲JavaWeb之AJAX 1.概述 以前我们在servlet中得到数据,必须通过域给jsp,然后jsp在响应给浏览器 纯html不能获取servlet返回数据 所以我们用jsp 但是现在我们可以同AJAX给返回数据了 我们可以在sevlet中直接通过AJAX返回给浏览器 html中的J…