github 프로세스 제안

[amoseui]

마일스톤, 프로젝트

• 마일스톤은 릴리즈 기준, 프로젝트는 스프린트, iteration 등으로 기간으로 관리하는게 편함
  • 프로젝트 보드에 이슈 티켓이 계속 쌓일 것이기 때문에 주기적으로 교체하는게 관리하기 편함 -> 기간 주기
  • 릴리즈 목표 버전 별로 마일스톤을 만들어서 어느 이슈가 어느 버전에 들어갈지 관리
• 보통 이슈 기준으로 PR을 만들기 때문에 PR은 마일스톤, 프로젝트에 따로 추가할 필요는 없을듯 (중복)
• PR description 에 이슈 링크를 추가하거나 Linked pull requests 등으로 1:1 링크도 가능

업무에서 사용하는 설정 + 개인 github 세팅

• 리뷰 프로세스 관련
  • Settings > Branches > Branch protection rules (master branch)
    • 보통 체크하는 것
    • Require a pull request before merging
      • Require approvals (리뷰, 빌드 등)
      • Dismiss stale pull request approvals when new commits are pushed
      • Require review from Code Owners (선택, CODEOWNERS 파일로 폴더/파일 단위로 리뷰어 관리 가능)
    • Require status checks to pass before merging (CI 가 있는 경우 어떤 job을 require 할 것인지 설정 가능)
      • Require branches to be update before merging
• Merge 방법
  • Settings > Options > Merge button
    • Allow squash merging 만 체크
      • 하나의 PR 당 하나의 commit 으로 submit 됨, 브랜치 분리, merge commit 없이 linear 하게 히스토리 관리돼서 보기 편함
      • PR에서 리뷰 중 추가 수정이 필요할 때는 amend 옵션 없이 추가 commit 을 새로 만들어서 올려서 추가 수정을 확인
      • merge 할 때는 하나로 합쳐서 submit됨

CI 에서 확인하면 좋은 것

• test coverage
  • gradle 에 jacoco 로 test coverage 추가
  • codecov, coveralls 등 외부 툴을 이용해서 PR에 봇이 comment 를 달거나 웹 UI로 따로 볼 수 있음
• 코드 스타일 등 -> ktlint? detekt? 자동으로 확인

[7loro]

branch protection rule 설정 및 merge option 변경 완료
code style 은 Kotlin 공식 coding convention (https://kotlinlang.org/docs/coding-conventions.html)을 기준으로 하며,
Android Studio - File - Settings - Editor - Code Style - Kotlin 에서 Set from 에서 Kotlin style guide 선택
세부적인 내용은 변경 될 수 있음

정적 검사를 통해 코드 스타일 검출 하는 것은 ktlint, detekt 적용을 이슈로 추가하여 별도로 작업하면 좋을 것 같습니다

마일스톤, 프로젝트는 제안해주신대로 마일스톤을 (1.0, 1.1, 2.0, 2.1, ...) 같이 버전 릴리즈 기준으로 하고
현재 LayoutProject 로 되어있는 프로젝트도 Iteration 을 기준으로 변경하겠습니다.

마일스톤 : 1.0, 1.1, 2.0, 2.1, ...
프로젝트 : 1st Iteration, 2nd Iteration, ...

[amoseui]

@7loro CI 추가되어 build status 강제화할 수 있을 것 같습니다. 반영 부탁드립니다.

• Require status checks to pass before merging (CI 가 있는 경우 어떤 job을 require 할 것인지 설정 가능)

이 옵션도 병렬로 작업하고 PR 을 반영하는 경우에 다른 PR 빌드가 깨질 수 있으므로 체크하면 좋습니다.

• Require branches to be update before merging
  (PR 에서 최신화할 수 있도록 버튼 제공함)

[7loro]

@amoseui 두 옵션 모두 체크하였습니다~!