Skip to content

Commit 7759ed4

Browse files
authored
HowTo-PRPR 규칙, 템플릿 작성 완료
`HowTo-PR` 및 `PR` 규칙, 템플릿 작성 완료
2 parents 9eb1742 + 8978d1c commit 7759ed4

File tree

12 files changed

+255
-0
lines changed

12 files changed

+255
-0
lines changed
65.5 KB
Loading
82.9 KB
Loading
77.6 KB
Loading
83.2 KB
Loading
55.5 KB
Loading
56.4 KB
Loading
60.1 KB
Loading
65.2 KB
Loading
77.1 KB
Loading

docs/how_to/How_to_contribute.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
2+
### 본 문서에서는 `Fork``Repo` 를 통해 상위 `Repo` 에 기여하는 법을 서술합니다.
3+
4+
---
5+
6+
### 1. 상위 `Repo``Fork-Repo` 동기화하기
7+
8+
여러분들이 `Fork-Repo` 에 개발한 내용을 상위 `Repo` 로 올리기 전, 동기화가 필요합니다. 이를 지키지 않을 시 `git 충돌` 이 일어날 수 있습니다.
9+
10+
<!-- contribute_1.png -->
11+
12+
<p align="center">
13+
<img src="../../assets/image/How_to_contribute/contribute_1.png", width=50%, height=50%>
14+
</p>
15+
16+
여러분의 `Fork-Repo` 상단을 보면 `Contribute`, `Sync fork` 버튼이 있습니다. `Contribute``Pull Request` 를 만드는 버튼이고 `Sync fork` 는 상위 `Repo` 와 동기화 하는 버튼입니다.
17+
18+
<!-- contribute_2.png -->
19+
20+
<p align="center">
21+
<img src="../../assets/image/How_to_contribute/contribute_2.png", width=50%, height=50%>
22+
</p>
23+
24+
`Sync fork` 를 누르면 동기화를 진행할 것인지 묻는 버튼이 나옵니다. 이 때 `Discard commits` 버튼을 누르면 `Fork-Repo` 의 개발 내용이 모두 사라질 수 있으므로 각별히 주의하시길 바랍니다.
25+
26+
<!-- contribute_3.png -->
27+
28+
<p align="center">
29+
<img src="../../assets/image/How_to_contribute/contribute_3.png", width=50%, height=50%>
30+
</p>
31+
32+
`Update branch` 버튼을 누르면 자연스레 동기화가 진행됩니다.
33+
34+
---
35+
36+
### 2. 상위 `Repo``Pull Request` 만들기
37+
38+
<!-- contribute_4.png -->
39+
40+
<p align="center">
41+
<img src="../../assets/image/How_to_contribute/contribute_4.png", width=50%, height=50%>
42+
</p>
43+
44+
`Contribute``Open Pull Request` 버튼을 누릅니다.
45+
46+
<!-- contribute_5.png -->
47+
48+
<p align="center">
49+
<img src="../../assets/image/How_to_contribute/contribute_5.png", width=50%, height=50%>
50+
</p>
51+
52+
버튼을 누르면 `PR` 에 포함될 커밋들을 볼 수 있습니다. 여기서 우측 `Create Pull Request` 버튼을 누르면, `Fork-Repo` 의 개발 내역을 상위 `Repo` 에 넣어주는 `PR` 을 생성할 수 있습니다.
53+
54+
<!-- contribute_6.png -->
55+
56+
<p align="center">
57+
<img src="../../assets/image/How_to_contribute/contribute_6.png", width=50%, height=50%>
58+
</p>
59+
60+
버튼을 누르면 해당 `PR` 이 무엇에 관한 내용인지 서술하는 내용이 나옵니다.
61+
62+
<!-- contribute_7.png -->
63+
64+
<p align="center">
65+
<img src="../../assets/image/How_to_contribute/contribute_7.png", width=50%, height=50%>
66+
</p>
67+
68+
기본 양식에 맞춰 작성 후, `Create Pull Request` 버튼을 누르면 완료됩니다.
69+
70+
---
71+
72+
### 3. `PR` 제출 이후
73+
74+
`PR` 은 말 그대로 요청하는 것이기 때문에, 상위 `Repo` 에 곧바로 적용되지 않습니다.
75+
76+
<!-- contribute_8.png -->
77+
78+
<p align="center">
79+
<img src="../../assets/image/How_to_contribute/contribute_8.png", width=50%, height=50%>
80+
</p>
81+
82+
위 그림은 상위 `Repo` 에 설정한 규칙으로 `"PR 이 수락되지 않은 상태"` 입니다. `PR` 이 수락되려면 적어도 관리자 1 명의 승인을 받아야 합니다.
83+
84+
<!-- contribute_9.png -->
85+
86+
<p align="center">
87+
<img src="../../assets/image/How_to_contribute/contribute_9.png", width=50%, height=50%>
88+
</p>
89+
90+
`PR` 제출 시 관리자가 변경점, 누락된 부분 등을 감안해 추가적인 내용을 요구할 수 있습니다. 관리자의 승인 후, 관리자의 `merge` 를 통해 여러분의 개발 내역이 상위 `Repo` 에 적용되게 됩니다.
91+
92+
---

0 commit comments

Comments
 (0)