Git 템플릿
Git 템플릿을 이용해서 통일된 형식으로 이슈와 PR 작성을 가능하게 해보겠습니다.
개발 내용을 명확하게 전달하고 공유할 수 있고 체크리스트로 실수를 방지할 수 있기 때문에 추천드립니다 😄
Issue 템플릿 적용
-
프로젝트에 들어가서 톱니바퀴 모양의 settings 탭을 누릅니다.
-
General 탭의 Features > Issues> Set up Templates를 누릅니다.
-
Custom Template을 클릭하고 아래와 같이 내용을 채워줍니다.
-
Propose changes를 누르고 커밋을 하면 .github 폴더 안에 아래와 같은 파일이 생성됩니다.
-
이슈를 생성해보겠습니다. 방금 만들었던 템플릿을 확인할 수 있습니다.
-
시작 버튼을 누르면 템플릿에 맞춰 내용을 작성할 수 있습니다.
PR 템플릿
-
PR 템플릿은 pull_request_template.md 파일을 직접 만들어야 적용이 됩니다.
-
위치는 다음 중 한 곳을 선택하면 됩니다.
- .github/pull_request_template.md
- docs/pull_request_template.md
- root directory 아래 /pull_request_template.md
-
방금 이슈 템플릿 생성으로 인해 .github가 생겼으니 .github 아래에 만들어보겠습니다.
-
해당 파일을 커밋하면 PR 생성 시에 템플릿 적용이 되는걸 확인할 수 있습니다 👍
