PR 규칙, 템플릿 정리

TIL

효ㄷi 2024. 7. 17. 22:46

PR 규칙, 템플릿 정리

PR 규칙은 말그대로 풀리퀘스트 올릴 때 쓰는 규칙인데,

협업할 때 정해두는 것을 권장하고,

템플릿도 만들어두면 PR 올릴 때 아주 편리하기 때문에 사용하는 것이 좋다.

우리 조 같은 경우엔 튜터님이 먼저 말씀 꺼내주시기도 했고, 꽤 중요시하시는 것 같아서

다른 조 규칙을 조금 참고하고, 블로그 PR 템플릿을 참고해 만들었다.

먼저 PR 규칙은

1. 매일 오후 7시 30분 쯤 다같이 pr 올리기.

2. 리뷰어는 2명 이상 필수

3. 커밋 컨벤션 사용할 땐 간편하게 소문자로

4. 커밋할 때 기능_브랜치명으로 저장하기

로 정했다.

그리고 pr 템플릿은

다른 블로그를 참고하고, 조금 불필요해보이는 것들을 정리해서

## 개요

## PR 유형

어떤 변경 사항이 있나요?

- [ ] ✨: 새로운 기능 및 라이브러리 추가

- [ ] 🎉: 기존에 없던 파일 생성 및 초기 세팅

- [ ] 🐛: 버그 수정

- [ ] 💄: CSS 등 사용자 UI 디자인 변경

- [ ] 🩹: 코드에 영향을 주지 않는 변경사항(오타 수정, 탭 사이즈 변경, 변수명 변경)

- [ ] ♻️: 코드 리팩토링

- [ ] 🔥: 파일 혹은 폴더명 수정 및 삭제

## PR Checklist

PR이 다음 요구 사항을 충족하는지 확인하세요.

- [ ] 커밋 메시지 컨벤션에 맞게 작성했습니다.

이렇게 만들었는데,

만드는 법은 간편하다.

먼저 최상위 폴더 바로 아래에

.github 라고 하는 폴더를 만들어주고,

pull_request_template.md 라는 이름으로 파일을 하나 만들어준 뒤

저 템플릿을 그대로 넣어주면 된다.

그럼 커밋올릴 때 저 화면이 뜰텐데

체크하는 방법은 여백 없이 저 대괄호 사이에 x를 넣어주면 된다!

개요 바로 밑에는 주석을 지우고 상세한 설명을 적어줘야 한다.

참고