Skip to content

Commit

Permalink
README: add section "how to work" (#4)
Browse files Browse the repository at this point in the history
- add git snippet when forking repositroy
- add git snippet when creating branch
  • Loading branch information
SangIlMo authored Apr 6, 2024
1 parent 2e4825d commit 993d3cb
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 993d3cb

Please sign in to comment.