Update collaborate_using_github.md#12
Update collaborate_using_github.md#12chromatices wants to merge 1 commit intoDeepBaksuVision:masterfrom
Conversation
191105 첫 마크다운 수정작업을 진행했습니다. 브랜치 전략부분에서는 별도의 수정을 하지 않았습니다. 깃을 처음사용하는 초보자의 시선에서 실수하지 말아야 될 부분을 강조하면서 작성했습니다.
| #### 1.2.2.1 원격 저장소 Fork | ||
|
|
||
| ---- | ||
| 공동으로 작업해올 저장소를 개인 저장소로 가져와야 합니다. fork의 경우 원격 저장소를 수정할 수 있습니다. 쉽게 설명드리면 프로젝트 저장소를 개인의 깃으로 가져오는 과정입니다. 이 과정을 거친 후에 로컬과 연결하는 작업을 진행할 수 있습니다. 프로젝트 저장소의 우측 상단부에 fork를 누른 후 개인 저장소로 복제해옵니다. 이를 공유 저장소라고 하겠습니다. |
There was a problem hiding this comment.
fork의 경우 원격 저장소를 수정할 수 있습니다.라는 멘트가 오해의 여지가 있는 것 같습니다.
fork를 하면 원격 저장소를 개인 저장소로 복사해오는 것이고 복사한 저장소를 수정할 수 있는 것입니다.
또한 복사한 저장소를 수정하고 수정된 내용을 원격 저장소에 Pull Request함으로 소스 메인테이너가 이를 반영할지 말지 반영할 수 있습니다.
이러한 맥락에서 해당 문구가 약간 오해의 소지가 있는 것 같은데 어떻게 생각하시는지요?
There was a problem hiding this comment.
차라리 쉽게 설명드리면 프로젝트 저장소를 깃으로 가져오는 과정입니다.라는 문구를 앞으로 댕기고 쉽게 설명드리면이라는 관용구를 제거해서 연결하면 조금 더 매끄러울 것 같습니다.
공동으로 작업해올 저장소를 개인 저장소로 가져와야 합니다. fork는 프로젝트 저장소를 개인의 깃으로 가져오는 기능입니다. 먼저 프로젝트 저장소의 우측 상단부에 fork를 누른 후 개인 저장소로 복제해옵니다. 이를 공유 저장소라고 하겠습니다.
너무 많은 정보를 포함하는 것보다는 핵심 정보를 간결하고 짧게 설명하는 게 좋다는게 제 의견입니다.
There was a problem hiding this comment.
최종적으로 검토하는 부분을 건너뛰어서 글이 지저분했던거 같습니다 수정하겠습니다
| #### 1.2.2.1 원격 저장소 Fork | ||
|
|
||
| ---- | ||
| 공동으로 작업해올 저장소를 개인 저장소로 가져와야 합니다. fork의 경우 원격 저장소를 수정할 수 있습니다. 쉽게 설명드리면 프로젝트 저장소를 개인의 깃으로 가져오는 과정입니다. 이 과정을 거친 후에 로컬과 연결하는 작업을 진행할 수 있습니다. 프로젝트 저장소의 우측 상단부에 fork를 누른 후 개인 저장소로 복제해옵니다. 이를 공유 저장소라고 하겠습니다. |
There was a problem hiding this comment.
개인적으로는 예시 그림이 있으면 좋을 것 같습니다.
단순하게 글만 있으면 처음 보는 사람이 접근하기 어려울 것 같습니다.
| #### 1.2.2.2 깃 초기화 및 환경설정 | ||
|
|
||
| 공유할 저장소를 받아오기 위해서는 빈 디렉토리가 필요합니다. 새로운 폴더에 깃 저장소를 생성하고 개인저장소에서 공유저장소의 주소를 clone해옵니다. | ||
| **반드시 clone or download에 있는 주소를 가져오셔야 합니다.*** |
There was a problem hiding this comment.
**반드시 clone or download에 있는 주소를 가져오셔야 합니다.***
마지막에 *이 하나 더 붙어있습니다.
| .... 작업 중..... | ||
| #### 1.2.2.2 깃 초기화 및 환경설정 | ||
|
|
||
| 공유할 저장소를 받아오기 위해서는 빈 디렉토리가 필요합니다. 새로운 폴더에 깃 저장소를 생성하고 개인저장소에서 공유저장소의 주소를 clone해옵니다. |
There was a problem hiding this comment.
개인저장소에서 공유 저장소의 주소를 clone해온다는 말이 무슨 의미인가요?
There was a problem hiding this comment.
local repository랑 햇갈렸습니다 수정하겠습니다
| 순서는 다음과 같습니다. | ||
|
|
||
| 1. 새로운 폴더를 만듭니다. 빈 폴더가 아니면 clone이 되지 않습니다. | ||
| 2. 해당폴더에서 터미널로 **git init** 으로 저장소를 초기화 해줍니다. |
There was a problem hiding this comment.
새로운 폴더에 깃 저장소를 생성하고, 개인 저장소에서 공유 저장소의 주소를 clone해오는 과정을 일련의 예제와 함께 설명하면 좋을 것 같습니다.
| 1. 새로운 폴더를 만듭니다. 빈 폴더가 아니면 clone이 되지 않습니다. | ||
| 2. 해당폴더에서 터미널로 **git init** 으로 저장소를 초기화 해줍니다. | ||
| 3. 저장소를 만든 폴더에서 개인 저장소에 있는 공유 저장소를 가져옵니다. **git clone (clone에 있는 주소)** 으로 공유 저장소 정보를 가져옵니다. | ||
| 4. 공유 저장소의 브랜치를 생성해줍니다. 보통 develop으로 이름을 지으며, 이는 프로젝트 저장소에서 풀리퀘를 할때 이름을 맞춰주셔야 실수로 merge하지 않기 위함입니다. **get add remote origin (공유 저장소 clone 주소)** |
There was a problem hiding this comment.
공유 저장소, 개인저장소의 정의를 서두에 해줘야할 것 같습니다.
공유 저장소에 브랜치를 생성해주는 개념이 맞는 것인지 모르겠습니다.
There was a problem hiding this comment.
초심자가 이해하기 쉽고자 설명했던 개념이 오히려 오해를 만드는거같네요 전반적으로 수정하겠습니다
| 5. 프로젝트 저장소와 싱크를 맞추기 위해 upstream 브랜치를 추가합니다. | ||
| **git add remote origin (프로젝트 저장소 clone 주소)** 로 upstream 브렌치를 추가합니다. | ||
| 6. **git remote -v** 명령어로 브랜치가 정상적으로 생성되었는지 확인해봅니다. | ||
| 7. **git fetch upstream** 명령어로 프로젝트 저장소와 동일한 환경을 만들어줍니다. 이 과정을 생략하게되면 풀리퀘가 올라가도 정상적으로 등록할 수 없으니 필히 시행해주시기 바랍니다. |
|
|
||
| #### 1.2.2.3 파일 올리기 & commit 및 push | ||
|
|
||
| 본인이 올릴 파일이나 폴더 디렉토리가 있을껍니다. 환경설정까지 진행한 폴더에 파일이나 폴더를 추가하고 이를 commit까지 하는 작업을 설명하겠습니다. commit은 되돌릴수 있으나, 작업을 간소화하기 위해 최대한 신중하게 해주는 편이 좋습니다. 실수했을 경우 환경설정부터 다시 다 해줘야 합니다.(commit을 취소했어도 git에서 새로운 파일을 인식하지 못하기 때문입니다.) |
There was a problem hiding this comment.
해당 부분은 브랜치 전략 설명을 안하면 난해할 것 같습니다.
|
|
||
| 본인이 올릴 파일이나 폴더 디렉토리가 있을껍니다. 환경설정까지 진행한 폴더에 파일이나 폴더를 추가하고 이를 commit까지 하는 작업을 설명하겠습니다. commit은 되돌릴수 있으나, 작업을 간소화하기 위해 최대한 신중하게 해주는 편이 좋습니다. 실수했을 경우 환경설정부터 다시 다 해줘야 합니다.(commit을 취소했어도 git에서 새로운 파일을 인식하지 못하기 때문입니다.) | ||
|
|
||
| 순서는 다음과 같습니다. |
2 participants
191105 마크다운 수정작업을 진행했습니다. 브랜치 전략부분에서는 별도의 수정을 하지 않았습니다.
깃을 처음사용하는 초보자의 시선에서 실수하지 말아야 될 부분을 강조하면서 작성했습니다.