Merge branch 'feature/mr' into 'main'

Add CLAUDE.md for project guidance and workflow documentation See merge request sgp-web-d/gameservice-fe-agent!1
2026-03-20 06:02:00 +00:00
parent 2b26f76e2f dbccdfc328
commit cec4bb6771
2 changed files with 188 additions and 57 deletions
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -0,0 +1,62 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+- **Type**: Game service frontend agent (submodule-based monorepo)
+- **Stack**: Nuxt 3/4, TypeScript (strict), pnpm
+- **Language**: Korean (코드 리뷰, 커밋 메시지, 문서)
+
+## Commands
+
+### Development
+```bash
+pnpm install    # Install dependencies
+pnpm dev        # Run dev server
+pnpm build      # Production build
+pnpm preview    # Preview build
+```
+
+### Validation
+```bash
+pnpm build      # Verify no build errors
+pnpm typecheck  # Verify TypeScript (if configured)
+```
+
+### Submodules
+```bash
+git submodule update --init --recursive   # Initialize
+git submodule update --remote --recursive # Update all
+```
+
+## Git Workflow
+
+### Branches
+- `release` - Production (verified)
+- `dev` - Development/testing
+- Feature branches from `dev`
+
+### MR Guidelines
+- **Title**: `[Category] Description` (Feature, Fix, Refactor, Docs)
+- **Target**: `dev` first, then `release` after verification
+- **Review**: 1+ team member approval required
+
+## Context Files
+
+Additional context in `.claude/` directory:
+- `contexts/` - Nuxt patterns, TypeScript conventions
+- `skills/` - code-review, test-generator, refactor-component
+- `agents/` - debugger, refactor, performance-optimizer
+
+## Project-Specific Patterns
+
+### Common Nuxt Issues
+- Hydration mismatch → Use `<ClientOnly>`
+- useFetch infinite loop → Check watch/immediate/key options
+
+### Key Conventions
+- Use Composition API with `<script setup lang="ts">`
+- Composables for reusable logic
+- Pinia for complex state management
+- Always type API responses: `useFetch<Type>()`
--- a/README.md
+++ b/README.md
@@ -1,93 +1,162 @@
 # gameservice-fe-agent

+게임 서비스 프론트엔드 에이전트 프로젝트

+## 프로젝트 구조

-## Getting started
+이 프로젝트는 **submodule 방식**으로 관리됩니다.

-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+## 브랜치 전략

-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+- `release` - 검증 완료 브랜치 (프로덕션 배포용)
+- `dev` - 검증 테스트 브랜치 (개발 및 테스트용)

-## Add your files
+## 설치 방법

- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+```bash
+# 저장소 클론 (submodule 포함)
+git clone --recurse-submodules https://git.sginfra.net/sgp-web-d/gameservice-fe-agent.git

-```
-cd existing_repo
-git remote add origin https://git.sginfra.net/sgp-web-d/gameservice-fe-agent.git
-git branch -M main
-git push -uf origin main
+# 이미 클론한 경우 submodule 초기화
+git submodule update --init --recursive
 ```

-## Integrate with your tools
+## Submodule 업데이트

- [ ] [Set up project integrations](https://git.sginfra.net/sgp-web-d/gameservice-fe-agent/-/settings/integrations)
+```bash
+# 모든 submodule 업데이트
+git submodule update --remote --recursive

-## Collaborate with your team
+# 특정 submodule 업데이트
+git submodule update --remote <submodule-path>
+```

- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+## 개발 워크플로우

-## Test and Deploy
+1. `dev` 브랜치에서 개발 및 테스트 진행
+2. 검증 완료 후 `release` 브랜치로 머지
+3. `release` 브랜치에서 프로덕션 배포

-Use the built-in continuous integration in GitLab.
+## 기여하기

- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+### 새로운 기능 추가

-***
+1. **브랜치 생성**
+   ```bash
+   git checkout dev
+   git pull origin dev
+   git checkout -b feature/your-feature-name
+   ```

-# Editing this README
+2. **개발 및 테스트**
+   - 기능 개발 및 단위 테스트 작성
+   - 로컬에서 충분한 테스트 진행

-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
+3. **Merge Request 생성**
+   - 제목: `[Feature] 기능명`
+   - 설명: 구현 내용, 변경 사항, 테스트 결과 포함
+   - 대상 브랜치: `dev`

-## Suggestions for a good README
+### Merge Request 작성 규칙

-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+- **제목 형식**: `[Category] 변경 내용`
+  - Category: `Feature`, `Fix`, `Refactor`, `Docs` 등
+  - 예: `[Feature] 사용자 인증 기능 추가`

-## Name
-Choose a self-explaining name for your project.
+- **설명 포함 사항**:
+  - 변경 이유 및 목적
+  - 주요 변경 내용
+  - 테스트 결과 및 방법
+  - 영향 받는 부분

-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+### 코드 리뷰 프로세스

-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+1. **최소 1명의 팀 멤버 승인** 필요
+2. **체크리스트**:
+   - [ ] 코드 컨벤션 준수
+   - [ ] 단위 테스트 작성 및 통과
+   - [ ] 문서화 완료
+   - [ ] 기존 기능에 영향 없음
+3. **승인 후 dev 브랜치에 머지**
+4. **dev 브랜치에서 충분한 검증 후 release 브랜치로 머지**

-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+---

-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+## 관리 방침

-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+### 버전 관리
+- Git 커밋 히스토리를 통해 모든 변경 이력 추적
+- Release 브랜치는 태그로 버전 관리 (예: `v1.0.0`)
+- Dev 브랜치에서 충분한 검증 후 Release로 배포

-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+### 브랜치 보호
+- **Release 브랜치**: 직접 푸시 금지, MR을 통해서만 머지
+- **Dev 브랜치**: 기능 브랜치에서 MR을 통해 머지
+- 모든 머지는 코드 리뷰 필수

-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+### 문서화
+- 주요 변경사항은 CHANGELOG.md에 기록
+- README는 항상 최신 상태 유지
+- 커밋 메시지는 명확하고 상세하게 작성

-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
+---

-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+## 사용 예시

-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+### 코드 리뷰 Skill 사용

-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+```markdown
+<!-- .claude/skills/code-review.md -->
+# Code Review Skill

-## License
-For open source projects, say how it is licensed.
+## 목적
+PR의 코드를 리뷰하고 개선사항을 제안합니다.

-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+## 사용법
+1. PR 번호를 제공
+2. Claude가 변경된 파일을 분석
+3. 코딩 컨벤션, 성능, 보안 관점에서 리뷰
+4. 개선사항 제안
+
+## 예시
+`/code-review #123`
+```
+
+### Nuxt 개발 가이드 활용
+
+```markdown
+<!-- .claude/contexts/nuxt-best-practices.md -->
+# Nuxt 베스트 프랙티스
+
+## 컴포넌트 작성
+- Composition API 사용
+- Composables로 로직 재사용
+- Auto-import 활용으로 간결한 코드 작성
+
+## 성능 최적화
+- 동적 import로 코드 스플리팅
+- useFetch, useAsyncData로 데이터 최적화
+- Lazy loading 컴포넌트 활용
+```
+
+### 기술 스택
+
+- **Framework**: Nuxt 3, Nuxt 4
+- **Language**: TypeScript
+- **Package Manager**: pnpm (권장)
+
+### 개발 환경
+
+```bash
+# 의존성 설치
+pnpm install
+
+# 개발 서버 실행
+pnpm dev
+
+# 프로덕션 빌드
+pnpm build
+
+# 프로덕션 미리보기
+pnpm preview
+```