풀리퀘스트(pull request)로 간단하게 코드 리뷰 하기 팀 교육 자료

1. 풀리퀘를 부탁해!
PULL REQUEST로 간편하게 코드 리뷰하기

2. 코드 리뷰?

3. 코드 리뷰?
 잠재 결함을 찾아 내고 개선하며 전반적인 S/W 품질을 높이려는 활동.
 S/W를 실행하지 않고 사람이 직접 검토.
 반드시 결함을 찾아 낼 수 있는 것은 아님!

4. 코드 리뷰를 하면?
좋은 코드 공유
팀 협업 강화
나쁜 코드 냄새
개발자 지속 성장
결함 발견
덤

5. 중요한 것은?

6. 리뷰 방법?

7. 팀 검토(Team Review)
https://www.youtube.com/watch?v=clCHUbaJV14

8. 문제는…

9. 코드 리뷰 시스템

10. 문제는…
분석 설계 구현 시험 배포
코드리뷰

11. 풀 리퀘스트(Pull Request)
http://www.slideshare.net/insomniac.at.work/introduction-to-github-slideshare

12. 하기 전에 잠깐!

13. 장애물
 할 일도 많은데 리뷰까지…
 지적에 대한 두려움

14. 코드 작성은…
 한 번에 하나의 작업만 커밋
 큰 이슈는 원자 단위(atomic)로 나눈다
 4h ~ 16h 동안 해결 가능한 크기가 일반적
 커밋 로그에는 이슈 번호 기록
 첫 번째 리뷰어는 바로 자신
 코딩 표준 준수
 경고 제거

15. 리뷰 요청은…
 리뷰는 작게 자주
 코드가 작으면 리뷰하기도 쉽다
 원할 때 마다
 완료하지 않았어도 원할 때마다 요청
http://hamster.school/ko/tutorial/scratch/line_tracer_one_sensor.jsp
From Puss in boots by Dreamworks

16. 리뷰는 언제…
 리뷰를 먼저
 정말 급한 일이 아니라면 리뷰 먼저
 그날 받은 리뷰는 그날 처리
 오후에 받은 거라면 다음날 오전까지
 늦어도 24시간 이내에
 늦어진다면 언제 할 수 있을지 요청자에게 알리고 의사를 묻자
 평소에 도저히 리뷰할 시간이 안 나면?
 리뷰하는 날을 정하자.

17. 리뷰할 때는…
 누구나 실수한다, 물론 자신도
 코드 ≠ 자신
 부드러운 어조, 칭찬하자!
 작성자의 결정 존중
 리뷰 내용 외 다른 내용은 언급 금지
 추후 문제가 생겨도 비난하지 말고 빨리 해결책 찾자
 글만으로 이해할 수 없으면 만나서
http://nownews.seoul.co.kr/news/newsView.php?id=20140102601008
http://www.dailymail.co.uk/embed/video/1153556.html

18. 리뷰는 무엇을…
 코딩 표준?
 불필요한 내용은?
 전체적인 디자인은?
 테스트하기 쉬운 구조?
 더 나은 로직은?
 재사용성과 확장성?
상황에 맞게 적절히

19. 본격적으로…

20. 기본 흐름
Discuss MergeBranch

21. 기본 흐름
Main Main’
Local
1. Fork
2. Clone
3. Fix
(branch)
4. Push (branch)
8. Push
5. Pull request
7. Fetch
6. Merge

22. Pull Request 만들기
 변경 내용을 (개인/작업) 저장소에 올림
 Stash에서 (개인/작업) 저장소 접속 후 Create pull request 선택
또는 Source, Commits, Branches 페이지 액션 메뉴에서 Compare 선택

23. Pull Request 만들기
 출발지와 목적지 브랜치 선택
 출발지: 코드를 변경한 브랜치
 목적지: 변경한 코드를 병합할 브랜치

24. Pull Request 만들기
 Diff, Commits 탭에서 변경 내용 먼저 확인
 Create pull request 선택
 제목은 한 줄 요약
 설명을 자세히
 멘션(mention) 기능
 @ + 사용자 표시 이름, 계정, 이메일 등
 리뷰어 추가

25. Pull Request 고치기
 Pull request 페이지에서 Edit 선택
 제목, 설명, 리뷰어
 목적지 브랜치

26. Pull Request 논의
 Pull request에서 가장 중요한 부분
 Overview
 전체 활동 내역
 전체적인 의견

27. Pull Request 논의
 Diff
 병합할 코드 내용 표시
 소스 파일 또는 코드 줄 단위 의견

28. Pull Request 논의
 Commits
 병합할 모든 커밋 목록
 Pull request를 생성한 브랜치 코드 변경  pull request 내용에 자동 반영
 Fetch 후 Local에서 확인
 git fetch origin pull-requests/2/from:pullrequest
 git checkout pullrequest

29. Pull Request 논의
 Pull request tasks
 논의 내용에 추가한 작업 목록
 Overview 또는 Shift+T로 목록 확인 가능

30. Pull Request 논의
 Jira 이슈 통합

31. Pull Request 합치기
 Pull request 페이지에서 Merge 선택
 Pull request에 대한 추가 정보 기록 가능
 Delete source branch after merging

32. Q&A
Reference
• http://www.slideshare.net/pioneerhjlee
/code-review-devon2013
• http://sv-story.blogspot.kr/2013/04/blog-post_28.html