Browse Source

:memo: add git pr workflow

Jeremy Zheng 3 years ago
parent
commit
4204036df5

+ 2 - 0
documents/deployment/README.md

@@ -12,6 +12,8 @@
 ## 镜像准备
 
 ```bash
+# 解压镜像
+tar xf palm-alpine.tar.xz
 # 导入镜像
 podman load -i palm-alpine-TIMESTAMP.tar
 # 启动镜像

+ 2 - 0
documents/development/README.md

@@ -79,6 +79,8 @@ cd ~/workspace
   curl -X GET http://localhost:9200/_cat/plugins?v
   ```
 
+## [git pr 流程](git/)
+
 ## 后端
 
 - [CPP20](cpp/)

+ 48 - 0
documents/development/git/README.md

@@ -0,0 +1,48 @@
+# GIT PR 流程
+
+## SSH KEY 设置(可选)
+
+- 创建 ssh key `ssh-keygen -t ed25519 -C "your_email@example.com"`
+- 打开 github settings 页面 放置 `~/.ssh/id_ed25519.pub`
+  ![ssh-key.png](ssh-key.png)
+
+## 常见 git 设置
+
+```bash
+git config --global core.quotepath false
+git config --global http.version HTTP/1.1
+git config --global pull.rebase false
+```
+
+## Fork & Clone 项目
+
+- fork 项目
+
+  - 点击 fork 按钮 ![1.png](fork/1.png)
+  - 输入项目信息 ![2.png](fork/2.png)
+
+- Clone 项目 `git clone git@github.com:YOUR_ID/mint.git ~/workspace/mint`
+  ![clone.png](clone.png)
+- 设置 upstream
+  ![set upstream](set-upstream.png)
+
+## 日常工作流程
+
+- 从自己的 repo 更新代码 `git pull` (可选,仅用于不同机器或目录间同步代码)
+- 从 upstream repo 更新代码 `git fetch upstream` (**必选** 每次开始工作前都要进行 以尽早发现冲突)
+- 提交代码
+
+  ```bash
+  git add FILE1 FILE2 FILE3
+  git commit -m "说明信息" FILE1 FILE2 FILE3
+  ```
+
+- 查看日志 `git log`
+- 推送到自己的 repo `git push`
+
+## 给主 repo 发 pr
+
+- 点击[pull requests](https://github.com/iapt-platform/mint/pulls)中的"New pull request"
+  ![new pr](pull-request/new.png)
+- 选择主 repo 的 branch(agile)和自己的 branch
+  ![comparing pr](pull-request/comparing.png)

BIN
documents/development/git/clone.png


BIN
documents/development/git/fork/1.png


BIN
documents/development/git/fork/2.png


BIN
documents/development/git/pull-request/comparing.png


BIN
documents/development/git/pull-request/new.png


BIN
documents/development/git/set-upstream.png


BIN
documents/development/git/ssh-key.png