아래의 템플릿을 사용합니다. 템플릿은 유지하되 자기가 납득할 수 있는 구조로 유하게 작성합니다.
PR 제목
[NDD-22]: PR 제목 (실제소요시간h / 스토리포인트h)
// 사용하지 않는 템플릿 제목은 삭제합니다
# Why
// Jira의 명시된 스토리포인트에서 변경된 시간만큼의 이유를 작성하기를 권장
// 혹은 이 테스크를 진행하게된 이유를 작성
# How
// 해당 테스크를 수행하기 위한 과정과 흐름에 대해 집중해서 작성합니다. (변경사항)
# Result
// 해당 테스크를 통한 결과에 대해 담백하게 작성합니다. (test 결과..?)
// 작업한 내용, 스크린샷
# Prize
// 해당 테스크를 통해서 어떤 기술적 성취가 있었는지 작성합니다.(수치적인 개선점 등)
# Reference
// 해당 테스크를 수행하며 참고한 Link를 모두 작성합니다. (Reference)
# Link
// jira 혹은 figma 링크를 작성합니다. (Jira ISSUE 번호)
리뷰어에게 당부할 말은 각 comment 에 넣어줄 것
FE에서는 프리커밋이란 행위를 1-2주차에 걸쳐서 오프라인으로 만나 선택적으로 진행할 예정(백로그 작성 시 결정)
BE에서는 프리커밋이란 프리코딩 회의를 통해 함수 워크플로우에 대한 이야기를 진행한다
모두가 comment 해주자 (서로 다른 포지션의 경우 LGTM(LG 트루모션)이라도 붙이고 가라 드립도 좋다. (칭찬은 아끼지 말 것)
서로 다른 포지션 (FE <=> BE)도 이해할 수 있도록 작성할 것
공통 포지션의 모든 구성원이 approve 해야만 merge 합니다.
태스크를 수행하던 모든 과정 중 “생각의 흐름”을 담으려고 노력하면 좋을 것 같습니다..
각 PR은 CI/CD 테스팅은 필수 (BE는 1주차부터, 6주차)
PR의 내용이 상세할 수록 blog를 작성하거나 추후 포트폴리오 작성에 큰 도움이 될 것 입니다. 단순히 프로젝트 수행 과정이 아닌 추후 포트폴리오 작성을 겸하고 있다고 생각하면 좋을 것 같습니다.
반영된 내용은 commit ID 적어주기