Contribution

Clone a repository

Repository를 clone 합니다.

git clone https://github.com/Bom-start/ReadingRecord.git

Create a branch

자신의 이름으로 브랜치를 생성합니다.

git branch [your-name]
git switch [your-name]

만약 이미 생성한 브랜치가 있다면, 로컬로 브랜치를 가져옵니다.

git switch [your-name]

Add commits

정리한 문서는 아래의 구성으로 디렉토리를 구성하여 추가해주세요.

\---토비의 스프링                  // 책이름
    +---vol1       
        +---1장                 // 챕터
            \--모영진.md         // 이름.md
        +---2장
        \---3장
    \---vol2 

Rebase and Push commits

커밋을 생성했다면 이제 원격저장소의 자신이 생성한 브랜치로 커밋을 push 해주세요 😀

✋🏼 하지만 잠깐만..!

push 하기 전에 main 브랜치의 변경사항을 rebase를 해야합니다.

rebase란, git에서 commit을 조작할 수 있는 명령어입니다.

다른 분들이 이미 원격저장소(Remote repo)의 main 브랜치에 PR을 올리고, 이 PR들이 merge 되었다면, 현재 저희가 각자 작업중인 로컬 브랜치에는 이 변경사항이 반영되지 않았기 때문에 PR을 생성하더라도 merge를 못하는 상황이 될거에요.

따라서 push 하기 앞서 원격저장소의 main 브랜치의 최신 커밋들을 먼저 로컬에서 반영한 이후 push 를 하는게 좋아요. 이 과정은 아래의 이미지로 이해하시면 도움될거에요!

이렇게 하면, 원격 저장소의 main 브랜치의 새로운 커밋들이 자신의 로컬 브랜치 커밋들로 추가될거에요 😀

커맨드라인 명령어는 아래에 정리했두었습니다! SourceTree와 같은 GUI 툴을 이용하시는 분들도 아래의 명령어 키워드로 검색하시면 방법을 찾으실 수 있을겁니다! 👌🏼

git switch main         // main 브랜치로 이동 (switch/checkout)
git pull main           // main 브랜치, 원격저장소와 동기화

git switch [your-name]  // 작업중인 브랜치로 복귀
git rebase main         // main 브랜치 변경사항을 현재의 브랜치로 가져오기 (rebase)

git log --oneline       // 커밋 히스토리가 의도한대로 조작 (rebase) 되었는지 확인 
git push                // 원격 저장소에 반영 (이제 PR이 가능한 상황)

Create a PR

새로 추가한 문서를 main브랜치에 반영을 원하신다면, main 브랜치로 PR을 생성해주세요.