[GitHub] PR 리뷰를 건설적이게!! (conventional commnet)

깃허브 PR 리뷰: 컨벤셔널 커멘트 사용!!!

- 코드 리뷰는 소프트웨어 개발의 중요한 부분

- 리뷰 과정을 체계적으로 관리하기 위해 컨벤셔널 커멘트 방법을 사용

 

컨벤셔널 커멘트

- 컨벤셔널 커멘트는 코드 리뷰 시 일관성 있는 피드백을 제공하기 위해 사용되는 코멘트 작성 방법

- 이는 코드 리뷰를 더 이해하기 쉽고, 추적하기 쉽게 만들어 줌

- 일반적으로 사용되는 컨벤셔널 커멘트

• nit: 사소한 수정 사항이나 제안.
• question: 이해를 돕기 위해 질문.
• suggestion: 대안적인 접근 방법이나 개선사항 제안.
• issue: 잠재적인 문제나 버그 지적.
• praise: 잘 작성된 코드에 대한 칭찬.

깃허브에서 PR 리뷰 시작하기

1. PR 열기: 리뷰할 PR을 클릭하여 오픈
2. 파일 변경 사항 확인: "Files changed" 탭을 클릭하여 변경된 파일을 확인

컨벤셔널 커멘트 사용

1. 코드 라인에 코멘트 추가: 변경된 코드의 특정 라인에 마우스를 올리면 나타나는 + 버튼을 클릭하여 코멘트를 추가합니다.
2. 코멘트 작성: 컨벤셔널 커멘트를 사용하여 명확하게 피드백을 남깁니다.

예시

• nit: nit: 여기에 공백이 하나 더 필요해요.
• question: question: 이 부분에서 왜 이 접근 방식을 사용했는지 설명해 주실 수 있나요?
• suggestion: suggestion: 이 함수는 더 작은 함수로 분리할 수 있을 것 같아요. 이렇게 하면 더 이해하기 쉬울 거예요.
• issue: issue: 이 로직은 null 값을 처리하지 않습니다. null 값을 처리하는 로직을 추가해 주세요.
• praise: praise: 이 부분의 코드는 매우 깔끔하고 이해하기 쉽네요! 좋은 작업입니다.

코멘트 작성 시 유의 사항

• 명확하고 간결하게: 코멘트를 이해하기 쉽게 명확하고 간결하게 작성합니다.
• 건설적인 피드백: 비판보다는 건설적인 피드백을 제공하여 협력적인 분위기를 조성합니다.
• 구체적이게: 가능하면 구체적인 예시를 제공하여 피드백이 더 도움이 되도록 합니다.

PR 리뷰 마무리

- 모든 코멘트를 작성한 후 "Submit review" 버튼을 클릭하여 리뷰를 제출

- 리뷰를 제출할 때 선택할 수 있는 옵션은 다음과 같음

• Comment: 피드백만 제공하고 승인은 하지 않습니다.
• Approve: PR을 승인합니다.
• Request changes: 변경 사항을 요청합니다.

 

컨벤셔널 커멘트를 사용하여 깃허브 PR 리뷰를 더 체계적으로 관리하여 코드 품질을 높이고, 팀원 간의 소통을 원활하게 합시다

 

참조

https://conventionalcomments.org/

Conventional Comments