Skip to content

Commit 993d3cb

Browse files
authored
README: add section "how to work" (#4)
- add git snippet when forking repositroy - add git snippet when creating branch
1 parent 2e4825d commit 993d3cb

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,55 @@ Golang execution layer implementation of the Ethereum protocol.
66

77
Orakle open-source EIP team repository.
88

9+
## How to Work
10+
11+
### If fork
12+
13+
the case for working on personal repository after fork (recommended)
14+
15+
1. Setting for the first time
16+
17+
```
18+
// add remote upstream
19+
git remote add upstream https://github.com/orakle-opensource/EIP_opensource.git
20+
```
21+
2. Working on personal repository
22+
```
23+
// create branch to work
24+
git checkout -b [branch_name]
25+
26+
// rebase upstream commits into branch
27+
git rebase upstream/master -i
28+
29+
// staging and commit
30+
git add .
31+
git commit -m "message"
32+
33+
// push
34+
git push -u origin [branch_name]
35+
36+
// go to upstream repo(https://github.com/orakle-opensource/EIP_opensource.git) and create pull request
37+
```
38+
3. After merging pull request
39+
```
40+
// checkout master and pull upstream commits
41+
git checkout master
42+
git pull upstream master
43+
```
44+
45+
### If branch
46+
47+
the case for working by creating branch on our repository
48+
49+
```
50+
// create branch -> commit -> push
51+
git checkout -b [branch_name]
52+
git add . | git commit -m "message"
53+
git push -u origin [branch_name]
54+
55+
// go to repo and create pull request
56+
```
57+
958
## License
1059

1160
The go-ethereum library (i.e. all code outside of the `cmd` directory) is licensed under the

0 commit comments

Comments
 (0)