PR guides

Pull Request 가이드

• 셀프 리뷰 - [부제] 팀원들이 내 코드를 볼 때 멈칫하지 않을까?!
• 요청 양식
• 리뷰 절차
• 📌 참고

feature 브랜치에서 작업을 끝내고, develop 브랜치로 병합하기 위해서는 다음과 같은 풀 리퀘스트 절차를 따라야 한다.

셀프 리뷰 - [부제] 팀원들이 내 코드를 볼 때 멈칫하지 않을까?!

변경 사항을 보며 내 코드를 처음 본다는 마음으로 먼저 셀프 리뷰를 진행한다.

# 셀프 리뷰 후 지워주세요
- [ ] PR에 관련없는 변경 사항이 포함되어 있지 않는가 (1 PR should do 1 thing)
- [ ] 코딩 스타일 가이드를 따르고 있는가
- [ ] 변수나 함수의 이름이 적절한가
- [ ] 리뷰를 요청하기 전에 직접 코드를 리뷰했는가
- [ ] 코드가 요구 사항을 충족하는가
- [ ] 테스트에 통과하는가
- [ ] 불필요한 주석이 없는가
- [ ] 매직 넘버가 없는가

요청 양식

    ## 간단한 요약 설명


    ### 관련 이슈
    ---
    * close #11
    * close #12
    * close #33

리뷰 절차

• 팀원이 PR을 날리면 모두가 하던 일을 잠시 멈추고, 그 PR에 대해 리뷰를 진행한다.

• 7시 이후 날린 PR은 다음 날 아침 스크럼 진행 후, 점심 전 1시간 30분동안 진행한다.

리뷰 받는 사람

• 리뷰어의 코멘트에는 무조건 답장해주기

• 리팩토링 등 PR은 일단 merge하고, 다음 PR에 반영한다.

리뷰 하는 사람

• 1개 이상의 리뷰를 남긴다.

• 참고할 자료도 리뷰에 같이 첨부한다.

📌 참고

9hobbes/h-draft

Devchecklists | Pull Requests Checklist

jp-ryuji/playbook_rails

멋진 2조의 PR 템플릿