참고

깃 컨벤션

PR 메시지 템플릿을 같이 만들면 좋겠습니다(총미)

[ feat : IDE-4 dsfdf ]

• IDE UI 개발

좋은 PR에 대한 단상🤔

• 제목규칙(한글 or 영어로)

<aside> 💡 PR 메시지 템플릿 (참고: https://bluayer.com/29)

IDE-1 이슈명 - 부제 (Optional)

변경내역(필수)

• 소스코드에 어떤 변화가 있는지 * 로 표현
• ex) 어쩌구 Component 개발
• 어쩌구 Component의 style 변경했다.

특이사항(선택)

• 이 부분은 수정할 내용이 발생할 것 같다.
• (참고 문서)
• 이후 Task ..

</aside>

→ (나리님) 템플릿

<aside> 💡 PR 메시지 템플릿 예시 (참고: https://bluayer.com/29)

Summary

• 내가 뭘 했는지

How to Review?

Needs more than 10 minutes for review? 리뷰에 10분이상 걸리는가? 걸린다면 얼마나 걸릴지

내가 PR 리뷰 부탁하기 전에 한 일 - 개인 테스팅을 해봤다거나 등

PR 리뷰가 끝나면 해야 하는 일

</aside>

<aside> 💡 **코드리뷰 - 코드 작성자편

리뷰어를 위해 충분한 정보를 제공한다 -** 코드의 구조, 설계 방식, 왜 이렇게 구현했는지, 왜 코드를 변경하게 되었는지 등 PR 요청시 충분한 설명을 함께 첨부

ESLint, Prettier 등의 툴을 이용해 코드 스타일을 보기 편하도록 정리한다.

리뷰를 받았다면 이모지나 코멘트를 남겨준다. - 질문에 대해선 대답을 해주고, 리뷰를 받았다면 잘 받았다는 코멘트나 이모지를 남기면 서로 더 잘 소통할 수 있다.

</aside>

<aside> 💡 **코드리뷰 - 리뷰어편

기능이 잘 작동하는지 확인한다.

네이밍이 적절한지 확인한다 - 변수명, 함수명, 클래스나 컴포넌트, 폴더명 등

코드를 더 간단하게 작성할 수 있는 방법이 있는지 확인한다.

중복된 코드나 불필요한 코드가 없는지 확인한다.

코드를 읽으며 궁금한 점이 있으면 질문한다.

배울만한 점, 내가 몰랐던 점들에 대해 말하고, 잘한 부분은 칭찬한다.**

</aside>

• 어떻게 하면 더 잘 할 수 있을까?

<aside> 💡 좋은 커뮤니케이션 방법

예의를 갖춘다.

대답 강요, 지시 말투 x → 제안, 질문하는 방식

피드백의 이유를 이해할 수 있도록 알려준다.

</aside>