Skip to content

docs: AI 리뷰 아키텍처 컨텍스트 추가#297

Merged
jaeyoung-kwon merged 3 commits into
devfrom
docs/ai-review-architecture
Jul 18, 2026
Merged

docs: AI 리뷰 아키텍처 컨텍스트 추가#297
jaeyoung-kwon merged 3 commits into
devfrom
docs/ai-review-architecture

Conversation

@jaeyoung-kwon

@jaeyoung-kwon jaeyoung-kwon commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

📌 What

  • AI 리뷰어가 봄봄 클라이언트의 워크스페이스 구조와 런타임 계약을 파악할 수 있는 아키텍처 문서 추가
  • PR 리뷰가 일반론이 아닌 저장소 고유 규칙과 실제 호출 관계를 기준으로 수행되도록 리뷰 절차 보완
  • ESLint와 Stylelint의 중복 포맷 및 병렬 실행으로 결과가 달라질 수 있는 문제 방지

❓ Why

  • AI 리뷰가 web, app, admin, maeil-mail, shared의 경계와 저장소 고유 계약을 이해하고 더 정확한 리뷰를 수행할 수 있도록 하기 위함
  • 동일한 TSX 파일을 ESLint/Prettier와 Stylelint가 함께 수정하면서 lint 실행마다 포맷 diff가 발생할 수 있어 포맷 책임과 실행 순서를 명확히 하기 위함

🔧 How

  • API·인증·라우팅·WebView·FCM·워크스페이스별 상태 관리 계약을 docs/architecture.md에 정리
  • AGENTS.md에서 PR 리뷰 전 아키텍처 문서를 필수로 읽도록 연결
  • AI 리뷰 스킬에 전체 파일 확인, 호출처 추적, 이웃 구현 비교와 레포 특화 finding 필터 추가
  • 리뷰 결과를 다음 리뷰 규칙과 아키텍처 문서에 반영하는 학습 루프 추가
  • Prettier의 embeddedLanguageFormatting을 비활성화해 TS/TSX 일반 포맷은 Prettier, Emotion CSS 속성 정렬은 Stylelint가 담당하도록 분리
  • web·admin·maeil-maillint:fix에서 ESLint 완료 후 Stylelint가 실행되도록 순서 고정
  • 별도 stylelint:fix 스크립트와 루트 alias를 제거해 auto-fix 진입점을 lint:fix로 단일화
  • AI 규칙 문서에 ESLint와 Stylelint 병렬 실행 금지 명시

👀 Review Point

  • 아키텍처 문서의 워크스페이스 경계와 런타임 계약이 현재 코드와 일치하는지 확인
  • AI 리뷰 절차가 docs/architecture.md를 읽고 실제 호출처까지 추적하도록 충분히 연결됐는지 확인
  • lint:fix 반복 실행 시 추가 포맷 diff가 발생하지 않는지 확인
  • Prettier 비활성화 범위가 Emotion CSS에만 의도대로 적용되고 일반 TS/TSX 포맷은 유지되는지 확인
  • auto-fix로 반영된 frontend 포맷 변경에 동작 변경이 없는지 확인

@jaeyoung-kwon jaeyoung-kwon left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 PR Review

✅ 확실하게 수정이 필요한 항목을 찾지 못했습니다.

docs/architecture.md 신규 추가와 AGENTS.md·ai-review-workflow SKILL.md의 리뷰 절차 보완이 핵심 변경이며, 나머지는 stylelint auto-fix로 인한 CSS 속성 순서 재정렬뿐입니다. architecture.md의 기술적 서술(cookie 기반 인증, ApiError shape, GET query 직렬화 규칙, 워크스페이스별 재시도 정책 등)을 shared/fetcher.ts와 web/main.tsx 실제 코드와 대조해 확인했고 모두 코드와 일치합니다. 문서에서 언급한 리뷰어 참고 파일 경로들도 모두 실제로 존재합니다. SKILL.md의 절차 단계 재번호(4→10, Architecture Learning Loop 추가)도 본문 내 다른 단계 참조(step 0, step 8)와 일관됩니다. CSS 변경은 각 rule 내 속성 순서만 바뀌었고 동일 속성의 중복 선언으로 인한 우선순위 역전 사례는 없어 동작 변경이 없습니다.

🚨 0 Critical · ⚠️ 0 Major · 📝 0 Minor

📋 검증 과정
  • Claude structured review 결과 중 확신도가 있는 항목만 정리했습니다.
  • Critical/Major는 inline comment로 게시하고, Minor는 참고 항목으로 summary에 포함합니다.
  • 자동 생성된 OpenAPI 타입 선언 파일과 lock 파일은 리뷰 대상에서 제외합니다.

🤖 Claude PR Review


Generated by Claude Code

@jaeyoung-kwon jaeyoung-kwon left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 PR Review

✅ 확실하게 수정이 필요한 항목을 찾지 못했습니다.

이전 리뷰 이후 추가된 lint 설정 변경까지 재검토했습니다. web·admin·maeil-mail의 lint:fix가 워크스페이스 내부에서 ESLint 다음 Stylelint를 순차 실행하고, 별도 stylelint:fix 진입점과 루트 alias가 함께 제거되어 문서와 스크립트가 일치합니다. Prettier의 embedded language formatting 비활성화 후에도 Stylelint가 Emotion TSX를 담당하며, 현재 head에서 pnpm -r lint:fix를 재실행했을 때 워킹트리 변경이 없었습니다. ESLint와 Stylelint 검사도 0 errors로 통과했고, 기존 CSS diff는 선언 값 변경 없이 정렬·표기 정규화만 포함합니다. architecture 문서와 리뷰 스킬의 경로·단계 참조도 실제 코드 및 현재 절차와 일치합니다.

🚨 0 Critical · ⚠️ 0 Major · 📝 0 Minor

📋 검증 과정
  • Claude structured review 결과 중 확신도가 있는 항목만 정리했습니다.
  • Critical/Major는 inline comment로 게시하고, Minor는 참고 항목으로 summary에 포함합니다.
  • 자동 생성된 OpenAPI 타입 선언 파일과 lock 파일은 리뷰 대상에서 제외합니다.

🤖 Claude PR Review

@jaeyoung-kwon
jaeyoung-kwon merged commit 1672d2d into dev Jul 18, 2026
4 checks passed
@jaeyoung-kwon
jaeyoung-kwon deleted the docs/ai-review-architecture branch July 18, 2026 16:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant