# 철학

> 결국 당신 코드를 유지보수하게 될 친구가 당신이 어디에 사는지 아는 광폭한 싸이코패스가 될 것이라고 여기고 코드를 작성하라
> — Martin Golding

merge 되는 코드가 당시의 맥락을 다 까먹을 정도로 한참 나중에도 봐야하는 코드이고, 심지어 내가 수정까지 해야하는 코드라고 생각한다.

---

# 코드 리뷰 요청 전 준비

## 커밋 컨벤션

### 기본 형식

```
[commit type]: [commit message]
```

### commit type

| 타입 | 설명 | 예시 |
|------|------|------|
| `feat` | 기능 구현 | `feat: 락커 회원 목록 검색 기능 추가` |
| `fix` | 버그 수정 | `fix: 상점 목록의 에러처리 예외케이스 대응` |
| `docs` | 문서(또는 주석) 관련 작업 | `docs: 데코레이터 옵션에 대한 문서 추가` |
| `refactor` | 리팩터링 | `refactor: createStore의 함수를 작은 함수로 분리` |
| `test` | 테스트 관련 작업 | `test: 상점 생성 테스트 추가` |
| `style` | 코드 스타일, 정렬에 관한 작업 | `style: 코드정렬 변경` |
| `design` | UI 디자인 반영에 관한 작업 | `design: 마이페이지 하단 버튼 UI 디자인 반영` |
| `build` | 빌드에 관련한 파일/설정 변경이나 추가 작업 | `build: 000라이브러리 의존성 추가` |
| `chore` | 기타 작업 | `chore: 프로덕션 빌드시 소스맵 생성하도록 변경` |

### commit message 규칙

- 작업한 내용을 간결하게 설명합니다
- 제목은 **50자**를 넘지 않아야 합니다
- 본문은 한 줄에 **80자**를 넘기지 않습니다
- 문장의 끝에 구두점(`.`)을 찍지 않습니다
- 문장은 **명사**로 끝나야 합니다
- 제목과 본문 사이는 한 줄을 개행하여 분리합니다

---

## 코드 리뷰 요청

### 코드 리뷰 요청 기준

- 리뷰 요청 전 반드시 **실행 및 기본 동작 확인** 후 요청
- 실행 전 공유가 필요한 경우 Pull Request는 **draft** 상태로 등록

### Github PR 단위

- 아사나에 이슈 카드를 만들고 최대한 **이슈 카드 하나에 연결**되는 정도로 나눈다

### Github PR 제목

- 아사나 이슈 카드 제목과 **동일**하게 구성한다
- 아사나 이슈 카드 2개 이상과 연결된다면 두 개를 아우를 수 있는 제목으로 선정한다

### Github PR 내용
PR 유형을 라벨로 표시한다.

```markdown
## 작업 배경
왜 이 작업을 하게 됐는지 간단히 설명해주세요.

## 작업 내용
무엇을 어떻게 변경했는지 설명해주세요.

## 영향 범위
변경으로 인해 영향을 받는 모듈, 컴포넌트, API 등을 적어주세요.

## 확인 방법
리뷰어가 직접 확인할 수 있는 방법을 적어주세요.
예상되는 엣지 케이스가 있다면 함께 적어주세요.

## 스크린샷 (UI 변경 시)
```

---

# 코드 리뷰 수행

## 확인 방법

- 출근 도장 찍듯이 출근하면 PR을 확인하자
- 가능한 즉시 출동
- 그 날 올라온 리뷰는 **그날 오후 5시**까지는 리뷰할 것
- PR을 확인할 때는 두 차례 확인합니다
  - **첫 번째 검토**: 코드 변경 사항을 개략적으로 파악
  - **두 번째 검토**: 세부 사항을 집중적으로 검토

## 리뷰 제출

### 🔴 Request changes

- 리뷰에 답변이 없으면 merge를 허락하지 않겠다
- 코드 수정이 없으면 merge 해선 안 된다

### 🟡 Comment

- Approve를 할 권리가 없는 사람은 없다!
- 하지만 Approve를 하기엔 찝찝하고 Request changes를 하기엔 애매할 때
- 승인절차와 관련없는 의견이나, 제안, 칭찬, 헛소리, 중얼거림

### 🟢 Approve

- 코드를 보면서 **타인에게 설명할 수 있을 정도**로 코드를 이해했다
- 해당 코드가 추가되어도 **서비스에 지장이 없다는 걸 확신**한다
- 만약 당시에 발견하지 못한 문제가 발생하더라도 **코드 작성한 사람을 함께 도울 수 있다**