블루베리 템플릿 리뷰 가이드
- 리뷰는 다다익선입니다!
- 친구의 인스타에 좋아요를 눌러주는 기분으로 모두 리뷰를 해주세요!
- 리뷰가 재미있다면 다른 오픈소스에도 참가해서 리뷰를 하고 코멘트를 다는 연습을 하면 오픈소스 기여자가 됩니다 :)
- PR 상단의 File changes를 클릭합니다.
- Review Changes 버튼을 클릭하고 문제없다면 Approve(승인)을 문제가 있다면 Comment를 작성합니다.
- LGTM은 Look Good To Me의 약자입니다.
- 참고로, 코드의 특정 부분에 지적이 있다면 + 버튼을 눌러서 ( 누른상태에서 아래로 드래그 해서 ) 해당 부분에 코멘트를 추가할 수 있습니다.
- 하지만, 반드시 Review Changes를 해줘야만 해당 코멘트가 PR 작성자에게 전달되니 주의하세요!
-
코드 확인
- CamelCase를 사용해야 합니다.
- 하나의 함수에는 하나의 기능만 구현되어 있어야 합니다.
- 무의미하게 StateFul하거나 Consumer 위젯을 사용해서는 안됩니다.
- 매직 넘버나, AppStrings에서 가져오지 않는 하드 코딩 값들을 사용해서는 안됩니다.
-
주석 확인
- 각 파일과 클래스 상단에는 파일의 목적과 간결한 설명을 주석으로 추가해야 합니다.
- 주석은 코드를 설명하는 것이 목적이므로, 코드 자체와 일치하고 중복되지 않도록 작성해야 합니다.
- 특히, 복잡하거나 중요한 메소드나 함수에는 추가 설명이 필요합니다.
-
네이밍 확인
- 변수, 함수, 클래스명은 의미를 명확하게 전달하도록 지어야 합니다.
- 이름 자체로 코드를 이해할 수 있도록 노력해야 합니다.
-
함수 및 메소드
- 각 함수와 메소드는 단일 책임 원칙을 따라야 합니다. 한 가지 기능만 수행하도록 작성되어야 합니다.
- 함수의 길이는 최대한 짧게 유지하고, 긴 함수는 필요한 경우에만 나누어 작성해야 합니다.
- 함수는 의존성 주입과 같은 좋은 설계 원칙을 따라야 합니다.
-
테스트
- 깃헙 워크플로우 빌드 테스트 결과가 통과되어 있는지 반드시 확인합니다.