Github_Repos/cvw
1
0
Fork 1
mirror of https://github.com/openhwgroup/cvw synced 2025-02-11 06:05:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #26 from ross144/main

Browse Source 
Clarified the git fork work flow.
This commit is contained in:
David Harris 2023-01-24 09:34:52 -08:00 committed by GitHub
commit 4358f0af95
1 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
gitflow.txt
View File

@ -21,21 +21,29 @@ Setup
1. goto github and fork openhwgroup/cvw.git 1. goto github and fork openhwgroup/cvw.git
2. clone: git clone --recurse-submodules git@ross144/cvw.git 2. clone: git clone --recurse-submodules git@ross144/cvw.git
3. git remote add upstream https://github.com/openhwgroup/cvw.git 3. git remote add upstream https://github.com/openhwgroup/cvw.git
4. install gh (github command line interface)
type -p curl >/dev/null || sudo apt install curl -y
curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg \
&& sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg \
&& echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null \
&& sudo apt update \
&& sudo apt install gh -y
Once per sessiosn Once per session (This authorizes gh to use your github account)
1. gh auth login 1. gh auth login
2. Use ssh and point to your public key 2. Use ssh and point to your public key
3. Copy one-time code from terminal to browser 3. Copy one-time code from terminal to browser
Fetch upstream and sync fork Fetch upstream and sync fork
1. git fetch upstream 1. git fetch upstream # fetch the upstream openhwgroup/cvw into your local clone
2. git merge upstream/main 2. git merge upstream/main # merge the upstream openhwgroup/cvw into your local clone
3. git push # pushes changes back to your fork. Now all three should be in sync
Create pull request Create pull request
1. git fetch upstream 1. git fetch upstream # fetch the upstream openhwgroup/cvw into your local clone
2. git merge upstream/main 2. git merge upstream/main # merge the upstream openhwgroup/cvw into your local clone
3. git push 3. git push # pushes changes back to your fork. Now all three should be in sync
4. gh pr create 4. gh pr create # Create a pull request.
5. Must include a title and strongly encourage a body message explaining your changes. 5. Must include a title and strongly encourage a body message explaining your changes.
6. Wait for pull request to be approved, rejected, or needs changes. 6. Wait for pull request to be approved, rejected, or needs changes.
7. Finish by fetching the upstream and pushing back to your fork. 7. Finish by fetching the upstream and pushing back to your fork.