diff --git a/gitflow.txt b/gitflow.txt index b8532460..bc89d2bf 100644 --- a/gitflow.txt +++ b/gitflow.txt @@ -21,21 +21,29 @@ Setup 1. goto github and fork openhwgroup/cvw.git 2. clone: git clone --recurse-submodules git@ross144/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 2. Use ssh and point to your public key 3. Copy one-time code from terminal to browser Fetch upstream and sync fork -1. git fetch upstream -2. git merge upstream/main +1. git fetch upstream # fetch the upstream openhwgroup/cvw into your local clone +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 -1. git fetch upstream -2. git merge upstream/main -3. git push -4. gh pr create +1. git fetch upstream # fetch the upstream openhwgroup/cvw into your local clone +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 +4. gh pr create # Create a pull request. 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. 7. Finish by fetching the upstream and pushing back to your fork.