[git] PR 템플릿 적용하기

ohtt-iOS·2021년 9월 12일
1

git

목록 보기
2/2
post-thumbnail

⚡️ 서론



사이드 프로젝트를 진행하면서 과거에 제가 짜둔 코드를 보면서
스파게티 코드란 이런 것이구나 ... ^-^ 를 느끼고 말았습니다.

앱을 배포한 후 초반에 마구 쏟아지는 버그를 해결하고 ...
이제 어느정도 안정화를 찾고 기능들을 추가하려고 하다보니
이제는 코드를 잘 정리해보자 ! 는 이야기가 나왔습니다 ( 물론 처음부터 했으면 좋았겠지만 ... )

그래서 코드리뷰라는 걸 해볼까 ! 하면서 이것저것 레퍼런스를 찾아보게 되었습니다.

뱅크샐러드 코드리뷰 문화 글을 읽어보다가 깃허브 템플릿이라는게 있다는 걸 알게되었습니다.
그래서 이걸 저희 프로젝트에 적용해보기로 했습니다 :)


🕶 세팅하기

1. 프로젝트 최상단에 .github라는 폴더를 만들어준다.

터미널로 프로젝트 최상단에 이렇게 입력해주시면 깃허브 폴더가 생깁니다!


mkdir .github

이 폴더는 숨겨진 파일 형태라서 평소에는 안보이지만
shift + cmd + . 을 하면 이렇게 보입니다.


2. 마크다운 파일을 만들어준다.


vi PULL_REQUEST_TEMPLATE.md

이 폴더안에 이렇게 풀리퀘스트 마크다운 파일을 하나 만들어줍니다.
이름을 이렇게 똑같이 해주셔야 깃허브에서 인식을 합니다 !


3. 안에 기본 작성 틀을 만든다.

(예시)

마크다운 형식으로 작성해주시면 됩니다.



📱 적용 결과


같은 방식으로 이슈 템플릿을 만들 수도 있더라구요 !
필요하신 분들은 함께 사용하시면 좋을 것 같아요 : )

profile
오뜨 삽질 🔨 블로그

0개의 댓글