written by : 김동윤
레포지토리 클론 받기 Git clone
먼저 PGL 이 만든 스프링 스터디 레포지토리를 git clone을 받아줍니다. private repo이니 Username과 Password를 물어보면 잘 입력합니다.
만일 2단계 인증 사용자라면 personal access token을 password로 입력해야 합니다.
이후 cd SpringBoot-study 로 디렉토리를 변경해줍니다 !
자신의 브랜치로 이동해서 작업하기 Git switch peer/peer이름
제가 미리 peer 분들의 브랜치를 만들어 놓을 예정입니다!
peer 분들은 각자의 브랜치로 git switch 합니다.
그리고 contents 폴더 안에 강의에 해당하는 아홉개의 챕터가 있을텐데
이번에 들은 강의의 Chapter 로 들어가서 자신의 이름으로 되어있는 md 파일에 자신이 학습한 내용을 첨부 혹은 정리해주시면 됩니다.
파일 구조 첨부
학습 내용 정리 관련
•
각자 공부한 기록을 남기는 것이 주요 목적이니깐 너무 부담 가지지 마시길 바래욥!!
노션/워드/벨로그에 정리하시는 분들은 처음부터 이 md파일에 작성하시기보다 노션에 정리하시고 이 md 파일에 복붙해주시는게 편하실 것 같습니다!
이미지나 노트에 정리하시는 게 편하신 분들께서도 원래대로 공부하신 후 공부하신 기록을 이미지로 남긴 후 해당 이미지 파일을 md 파일에 붙여주시면 따로 부담 없으실 것 같습니다!
•
pdf 파일로 첨부하셔도 너무 좋아요! pdf 파일은 그냥 드래그앤드롭으로 해당하는 chapter 폴더에 넣어주시기만 하고 이름만 성명.pdf로 해주시면 됩니다!
•
md 파일에 이미지 넣는 법 :
학습 내용 정리 push & pull request
만약 peer1 분이 Chapter1 강의를 듣고 정리해주신다고 하면 아래와 같은 파일 경로에 학습한 내용을 정리해주시면 됩니다. (각 chapter 의 소제목을 포함한 템플릿은 pgl이 만들어놓을 예정)
1.
git add . 명령어 (add 뒤에 한 칸 띄고 . 붙여주셔야 합니다!) 를 통해 내가 수정한 파일을 추적합니다.
2.
git commit -m "커밋메시지" 명령어를 통해 커밋을 날립니다.
이때 커밋 메시지는 peer/자신의이름 : Chapter번호 학습 내용 정리 으로 해줍니다~
3.
git pull origin main 을 통해 main에서의 변경사항이 있을 수도 있으니 한번 끌어와주고
4.
git push origin [브랜치명] 명령어를 통해 push 해줍니다 !
여기서는 git push origin peer/김동윤 으로 되겠네요!
5.
위와 같이 자신의 브랜치로 push 를 하고 레포지토리에 들어가보면 compare & pull request가 만들어집니다!
⇒ (빨간 체크 부분 클릭) Compare, pull request 를 누르면
⇒ 위와 같이 자신이 한 내용 소개, 참고해서 읽어주시면 좋을 것 같은 사항들을 템플릿에 맞춰 / 혹은 자유롭게 적은 뒤 Create pull request 눌러주면 아래와 같이 pull request 가 생성됩니다
이때 pull request 제목은 아래 이미지와 같이
[peer/내이름] : 수행한 내용 형식으로 설정해주시고
pr 내용은 폴더 안에 템플릿 가져다 쓰셔도 되고 쓰고 싶은 내용 자유롭게..
(+)
처음 pr 진행 후부터의 pr은 아래와 같이 진행해주시면 됩니다
1.
New Pull request 만들기
2.
자신의 브랜치를 compare에서 지정 (저같은 경우는 pgl/김동윤!)
3.
create pull request 해주세요! (다만 커밋한 내역이 없거나 , 즉 main 브랜치와 다른 점이 없다면 당연히 추가적으로 push 할게 없으니 pr이 생기지 않겠죠!? 새로운 내용을 커밋하고 나서 pr을 만들어주셔야 해용!)
4.
제목 & 내용 써주기 → create pull request 누르면 pr 만들어집니당 ㅎㅎ
6.
pr 날린 후 피드백
7.
⇒ peer들이 이 pull request를 merge 하기 전에 files changed를 눌러 해당 동료분이 추가하신 내용을 읽고 수정, 추가 되어야 할 사항들을 코멘트로 남겨주고 (없으면 넘어갈 수 있음)
⇒ 해당 코멘트를 반영해 peer분이 내용 최종 작성 완료하면
⇒ merge pull request로 내용을 완전히 레포지토리에 저장해주면
⇒ peer분이 작성한 내용이 우리의 팀 레포지토리에 잘 반영됩니다 :D
모르는 부분 / 공부하다가 에러 사항이 생기면 github에 issue 생성!
1.
이슈 탭에 들어간다.
2.
New Issue를 생성한다
3.
Chapter 번호 : 모르는 부분에 관한 내용/에러 사항 발생 이라는 제목과 함께 내가 모르는 내용, 발생한 에러 사항에 대한 내용을 작성한다.
(ex1) 에러 발생
(ex2) 모르는 부분 발생
Issue 에 함께 문제를 해결 , 완료 시 close issue
PR 방식의 깃허브 스터디를 통해서..
이런 방식으로 각자 내용을 정리하고, 이를 팀 레포지토리에 한데 모아서 기록, 다른 PEER들의 정리 내용을 한번 읽는 과정을 통해
내가 강의를 들으면서 놓친 부분은 없었는지!? 점검 가능! 자연스러운 강의 내용 복습 가능 다른 PEER들이 추가적으로 찾아서 정리한 내용 + 심화 내용을 읽어보면서 심화 내용 추가 습득 우리 PEER GROUP만의 공동 스터디 기록 일지, 소중한 기록 GET 가능!