Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: add section "how to work" #4

Merged
merged 2 commits into from
Apr 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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