From 993d3cb01c210518019f5999cf90350d6c4e33c9 Mon Sep 17 00:00:00 2001 From: SangIlMo <156392700+SangIlMo@users.noreply.github.com> Date: Sat, 6 Apr 2024 17:31:50 +0900 Subject: [PATCH] README: add section "how to work" (#4) - add git snippet when forking repositroy - add git snippet when creating branch --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/README.md b/README.md index 011edc5873..f86a472a55 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,55 @@ Golang execution layer implementation of the Ethereum protocol. Orakle open-source EIP team repository. +## How to Work + +### If fork + +the case for working on personal repository after fork (recommended) + +1. Setting for the first time + +``` +// add remote upstream +git remote add upstream https://github.com/orakle-opensource/EIP_opensource.git +``` +2. Working on personal repository +``` +// create branch to work +git checkout -b [branch_name] + +// rebase upstream commits into branch +git rebase upstream/master -i + +// staging and commit +git add . +git commit -m "message" + +// push +git push -u origin [branch_name] + +// go to upstream repo(https://github.com/orakle-opensource/EIP_opensource.git) and create pull request +``` +3. After merging pull request +``` +// checkout master and pull upstream commits +git checkout master +git pull upstream master +``` + +### If branch + +the case for working by creating branch on our repository + +``` +// create branch -> commit -> push +git checkout -b [branch_name] +git add . | git commit -m "message" +git push -u origin [branch_name] + +// go to repo and create pull request +``` + ## License The go-ethereum library (i.e. all code outside of the `cmd` directory) is licensed under the