Skip to content

Ground Rule

WIPchan edited this page Jul 7, 2025 · 9 revisions

🛠 팀 컨벤션 & DB 설계 개요

✅ 핵심 요약

  • 브랜치 전략: master / develop / feature/기능명
  • 스크럼 & 코드리뷰 일정: 매일, 7/11, 7/18
  • 주요 테이블: Auth, User, Setting, News, History , Hot_topic
  • 커밋 메시지 규칙: Gitmoji 사용

🌿 브랜치 전략

브랜치명 설명
master 프로덕션 배포 브랜치
develop 통합 개발 브랜치
feature/xxx 기능 단위 개발 브랜치 (feature/kakao-login 등)

📦 ERD 주요 테이블 구성 (클릭하여 펼치기)

  • User: 카카오 유저 정보
  • Auth: OAuth2 인증 정보
  • Setting: 유저가 설정한 알림 시간/요일/키워드
  • SettingKeyword, SettingBlockKeyword: 키워드 필터링
  • News, NewsSummary: 기사 정보 및 요약
  • HotTopic, History, SentNews: 전송 이력 및 통계 관리

외래키 및 기본키는 각 테이블 정의와 함께 명확히 구성


📘 Git 커밋 컨벤션 (Gitmoji 목록 보기)

아이콘 타이틀 설명 메시지
[기능 추가] 새 기능 Introduce new features.
💡 [주석 추가] 주석 추가/수정 Add or update comments in source code.
🔥 [코드 제거] 코드/파일 삭제 Remove code or files.
🔀 [브랜치 병합] 브랜치 합병 Merge branches.
♻️ [리팩토링] 코드 리팩토링 Refactor code.
🎨 [구조 개선] 코드의 구조/형태 개선 Improve structure / format of the code.
⚡️ [성능 향상] 성능 개선 Improve performance.
🐛 [버그 수정] 버그 수정 Fix a bug.
🚑 [긴급 수정] 긴급 수정 Critical hotfix.
📝 [문서화] 문서 추가/수정 Add or update documentation.
💄 [UI 업데이트] UI/스타일 파일 추가/수정 Add or update the UI and style files.
🎉 [프로젝트 시작] 프로젝트 시작 Begin a project.
[테스트] 테스트 추가/수정 Add or update tests.
🔒 [보안 수정] 보안 이슈 수정 Fix security issues.
🔖 [릴리즈 태그] 릴리즈/버전 태그 Release / Version tags.
💚 [CI 수정] CI 빌드 수정 Fix CI Build.
📌 [의존성 고정] 특정 버전 의존성 고정 Pin dependencies to specific versions.
👷 [CI 구성] CI 빌드 시스템 추가/수정 Add or update CI build system.
📈 [분석 추가] 분석, 추적 코드 추가/수정 Add or update analytics or track code.
[의존성 추가] 의존성 추가 Add a dependency.
[의존성 제거] 의존성 제거 Remove a dependency.
🔧 [구성 변경] 구성 파일 추가/삭제 Add or update configuration files.
🔨 [스크립트 작업] 개발 스크립트 추가/수정 Add or update development scripts.
🌐 [국제화] 국제화/현지화 Internationalization and localization.
💩 [코드 개선 필요] 똥싼 코드 Write bad code that needs to be improved.
[롤백] 변경 내용 되돌리기 Revert changes.
📦 [패키지 작업] 컴파일된 파일 추가/수정 Add or update compiled files or packages.
👽 [API 수정] 외부 API 변화로 인한 수정 Update code due to external API changes.
🚚 [리소스 이동] 리소스 이동, 이름 변경 Move or rename resources.
📄 [라이센스] 라이센스 추가/수정 Add or update license.
🗃 [DB 변경] 데이터베이스 관련 수정 Perform database related changes.
🔊 [로그 업데이트] 로그 추가/수정 Add or update logs.
🙈 [.gitignore] .gitignore 추가/수정 Add or update a .gitignore file.

🔧 Spring / DB 컨벤션 (네이밍, 컬럼 기준 등)

  • 클래스: PascalCase, 메서드/변수: camelCase
  • 테이블/컬럼: PascalCase → 예: UserSettings, UserId
  • 기본 컬럼: Id, created_at, updated_at, IsActive
  • API 문서 자동화: SpringDoc 기반

Clone this wiki locally