Skip to content

Latest commit

 

History

History
53 lines (40 loc) · 7.57 KB

git.md

File metadata and controls

53 lines (40 loc) · 7.57 KB

커밋·PR·이슈

커밋

  • Conventional Commits(pnpm commit 권장), 설명은 한국어다. 본문 줄은 100자 이하다(commitlint). type은 commitlint의 feat·fix·docs·refactor·perf·test·ci·chore다. scope는 server·mobile·api(공유 계약)를 쓰고, 저장소 전체면 생략한다.
  • 제목은 사용자나 코드가 무엇이 달라지는지를 문장으로 쓴다(fix(mobile): 자정이 지나도 위젯이 앱을 열기 전에 새 날짜를 표시한다). 본문에는 문제·원인·변경과 실제 실행한 검증을 쓴다. 커밋에 Co-Authored-By 트레일러를 넣지 않는다.
  • Git 훅은 lefthook이 관리하고 pnpm install의 prepare가 설치한다. 테스트는 이 훅에서 turbo로 실행해 결과를 팀 원격 캐시에 올린다. CI가 같은 캐시를 재사용하고 놓친 작업만 실제로 돈다.
    • pre-commit: staged 파일에 oxlint --fix·oxfmt --write를 적용해 다시 stage하고, CI 정책 테스트(scripts/ci/*.mjs 변경 시), 문서 검사(pnpm docs:check, 커밋마다)와 파일 이름 검사(apps/api/src·packages/api/src·모바일 features/·app/ 변경 시 ls-lint)를 실행한다. 코드 관례는 oxlint의 aido/* 규칙이 staged 파일에서 본다.
    • pre-push: 코드가 바뀐 push만 turbo run typecheck test test:node build, 서버 통합·배포 앱 계약 테스트(test:integration·test:contract)를 실행한다. 동시 실행 수를 2(통합·계약은 1)로 묶어 맥북 부하를 줄인다. 문서만 바뀐 push와 merge·rebase는 건너뛴다. 입력이 같으면 캐시를 쓰고 결과가 원격 캐시에 올라간다. 통합·계약 테스트는 로컬 Docker(Testcontainers)가 필요하다. 전체 E2E는 pnpm test:e2e로 직접 실행하고 PR 본문에 기록한다. CI에서는 돌리지 않는다.
    • commit-msg: commitlint.
  • 훅을 건너뛰지 않는다(--no-verify 금지). 훅 자체가 고장 난 긴급 상황에서만 LEFTHOOK=0 git …을 쓰고, 건너뛴 검사는 바로 수동으로 실행해 PR 검증에 적는다. 특정 job만 빼려면 LEFTHOOK_EXCLUDE=<job 이름>을 쓴다.

PR

  • PR은 main을 향한다. develop은 더 이상 통합 브랜치가 아니다.
  • 제목은 커밋과 같은 type(scope): 문장이다. stack PR도 제목에 순서([n/N])를 넣지 않는다. 순서는 브랜치 NN-slug·gh stack의 PR 묶음·Epic 목록이 말하고, 층을 더할 때 제목을 고치지 않아도 된다.
  • 본문은 PR 템플릿의 요약·주요 변경·검증을 기본으로 한다. 재현·성능·위험·배포·화면 자료는 필요한 경우만 제목을 더한다. 요약 끝에 Closes #<이슈>를 쓰고 stack이면 · Epic #<에픽>을 붙인다.
  • 주요 변경은 문제(파일:줄·측정값), 바꾼 것, 왜 이 설계(버린 대안 포함) 순서로 쓴다.
  • 라벨은 연결한 이슈와 같게 단다(type:* 하나, 바뀐 앱마다 scope:*, priority:*, stack이면 stack:<release>).
  • 처음 보는 리뷰어(면접관)가 읽고 판단할 수 있게 쓴다. 바꾼 이유와 버린 대안을 적고, 코드 품질 개선은 실제 base/head에서 발췌한 짧은 Before/After 코드와 경로를 붙인다.
  • 숫자는 측정한 값만 쓴다(조건·환경 포함). 측정하지 않은 개선율·예상치를 쓰지 않는다. 로컬 통과·merge·운영 배포를 구분해 적는다.
  • assignee를 지정한다.
  • PR·이슈·README에 서비스 규모(가입자·사용량·매출)를 적지 않는다. 근거 숫자는 자원 한도와 시간(연결 한도, 이미지 크기, CI 소요)을 쓴다.

Stack

  • 의존하는 PR은 gh stack으로 쌓고(gh stack add·gh stack submit --auto) 같은 stack:<release> 라벨(예: stack:1.13.0)을 단다. 맨 아래 PR만 main을 향하고 나머지는 바로 아래 브랜치를 향한다.
  • CI는 main을 향한 PR과 main push에서만 돈다(CI). 위층의 누적 tree는 tip을 push할 때 pre-push가 검증하고, 합친 뒤 main CI가 이미지 발행 전에 다시 검증한다. 각 PR은 혼자 빌드·테스트를 통과하도록 나눈다.
  • 아래 층을 고치면 그 브랜치에서 커밋하고 gh stack rebase --upstack으로 위층을 다시 쌓는다. 공유 브랜치의 이력을 바꾸는 rebase·force push는 그 stack의 담당 범위에서만 한다.
  • 합칠 때는 gh stack merge --yes로 stack 전체를 한 번에 main에 합친다. main push가 한 번이라 운영 배포도 한 번이다(deploy.yml은 main CI 성공마다 배포한다).
  • 다 합친 뒤 gh issue list --state open으로 stack 이슈가 모두 닫혔는지 확인한다. 남은 이슈는 PR 머지 커밋이 main에 있는지(git merge-base --is-ancestor) 확인하고 PR 링크와 함께 닫는다. 부모 브랜치를 향한 PR의 Closes #N은 GitHub가 처리하지 않는다(GitHub 문서).

버전

버전 번호를 갖는 것은 앱 하나다. 서버는 main에 합칠 때마다 배포되므로 번호 대신 커밋 SHA로 식별한다.

대상 식별 올리는 방법
앱(@aido/mobile) apps/mobile/package.json의 version(스토어 버전). app.config.ts가 이 값을 읽는다 스토어 릴리스마다 직접 올린다. 빌드 번호는 EAS remote가 관리한다
서버(@aido/server)·공유 계약(@aido/api) 커밋 SHA: 이미지 태그, Sentry release(aido-server@<sha>), 서버 배포 기록 올리지 않는다. package.json의 version은 0.0.0으로 둔다
  • 앱과 서버의 호환은 버전 번호가 아니라 계약이 지킨다. 출시 계약은 추가만 하고, 앱 버전에 따라 달라지는 동작은 X-App-Version으로 가른다(호환).
  • 앱 버전만 올리는 커밋은 서버 이미지를 만들지 않는다. 스토어 릴리스 때문에 서버를 다시 배포하지 않는다.
  • 릴리스에서 달라진 것은 docs/releases/<앱 버전>/에 남긴다. 서버만 고친 변경은 그 PR과 커밋(Conventional Commits)이 기록이다.

이슈

배경·목표·완료 조건을 적는다. 완료 조건은 확인할 수 있는 동작이나 검사로 쓴다.

  • 제목은 [Feature]: 대상: 문장 또는 [Bug]: 대상: 문제를 고친다다. 대상은 앱·서버·공통이다. 리팩터·성능·문서도 [Feature]이고 종류는 type:* 라벨이 말한다.
  • 본문은 ### 배경·### 목표·### 완료 조건(체크박스)이다. stack 이슈는 ### 진행 방식에 브랜치(stack/<release>/NN-slug)와 Epic 번호를 적는다.
  • 라벨은 type:* 하나, 바뀌는 앱마다 scope:*, priority:*, stack이면 stack:<release>를 단다. Assignee를 지정한다.
  • 릴리스 stack은 Epic 이슈([Epic]: <release> 문장) 하나를 둔다. Epic은 배경·목표·핵심 결정(결정·이유·버린 대안 표)·완료 조건·레이어 이슈 목록(- [ ] #이슈 \NN-slug` — 제목`)·진행 방식을 갖는다.