OnTheTop Backend Wiki

서비스 바로가기

개발 일정

기간	주요 작업
04/16 ~	ERD 설계

컨벤션 룰

1. 코드 스타일 가이드

EditorConfig 설정

설정 항목	값	설명
charset	utf-8
end_of_line	lf
indent_style	space
insert_final_newline	true
trim_trailing_whitespace	true
max_line_length	120

2. CheckStyle 설정

항목	규칙
클래스명
변수명 및 메서드명
상수명
패키지명
탭 사용
줄 바꿈
최대 라인 길이
제어문 블록 {}
연산자 배치
import 순서
주석 스타일

3. 커밋 메시지 컨벤션

커밋 메시지는 type: message 형식을 따르며, 아래의 규칙을 따릅니다.

제목 규칙

제목은 소문자로 작성합니다.
제목 끝에 마침표(.)를 사용하지 않습니다.
제목은 최소 5자 이상이어야 합니다.
전체 헤더는 72자를 초과하지 않아야 합니다.

🔹 커밋 메시지 타입

타입	용도	예시
feat	새로운 기능 추가	feat: 게시글 작성 기능 추가
fix	버그 수정	fix: 로그인 실패시 예외 처리 수정
docs	문서 작업 (README, API 명세 등)	docs: 프로젝트 설치 가이드 추가
style	코드 스타일 변경 (포맷팅, 세미콜론, 들여쓰기 수정 등)	style: 코드 포맷 통일
refactor	리팩토링 (기능 변화 없이 코드 구조 개선)	refactor: 회원가입 로직 단순화
test	테스트 코드 추가/수정	test: 로그인 기능 단위 테스트 추가
build	빌드 관련 파일 수정 (webpack, vite, gradle, package.json 등)	build: webpack config 수정
ci	CI 설정 수정 (GitHub Actions, Jenkins 등)	ci: 테스트 워크플로우 수정
cd	CD 배포 설정 수정 (Helm, deploy script 등)	cd: production 배포 스크립트 수정
chore	기타 사소한 변경 (코드 변경 없는 설정 파일 등)	chore: .gitignore 파일 업데이트
rename	파일/디렉토리 이름 변경 (의미 변화 없음)	rename: authController → userController로 파일명 변경
remove	코드, 파일, 디렉토리 삭제	remove: unused API endpoint 삭제

🔹 커밋 메시지 형식

<타입>: <간결한 변경 요약>

본문 (선택)
- 필요한 경우 왜, 어떻게 수정했는지 추가
- "무엇을 했는지" + "왜 했는지"

4. 추가 규칙

PR 제목은 커밋 메시지와 동일한 형식을 유지합니다.
한 번의 PR은 하나의 목적을 가져야 합니다.
코드 리뷰를 거친 후 병합을 수행합니다.

이 컨벤션을 준수하여 팀의 코드 품질을 유지하고 원활한 협업을 진행합시다!

🔹 브랜치 기본 규칙

📍 브랜치명은 소문자로 작성하며, -(하이픈)으로 구분합니다.

main: 항상 "배포 가능한" 상태 유지
feat/작업명: 기능 개발용
fix/이슈명: 버그 수정용
hotfix/긴급패치명: 바로 배포해야 하는 긴급 수정
release/버전명: 배포 준비용 (선택)

예시

feat/login-api
fix/typo-post-title
hotfix/login-redirect-error
release/v1.0.0

🔹 브랜치 작업 규칙

dev 브랜치 최신 가져오기 : 명령 위치(dev)
```
git checkout dev
git pull --rebase origin dev
```
기능(feat) 브랜치 파기 : 명령 위치(dev)
```
git checkout -b feat/login
```
작업 완료 후 PR 올리기 직전(dev에 PR) : 명령 위치(feat 브랜치)
```
git fetch origin
git rebase origin/dev
```
- 이 때, Local에서 conflict 해결
GitHub나 GitLab에서 PR 올릴 때 → "Squash and Merge"로 병합
- 하나의 깔끔한 커밋으로 dev에 머지
병합 후 feat/login 브랜치는 삭제 : Local 과 원격 모두.
```
git branch -d feat/login
```

트러블 슈팅

1. 트러블 슈팅 제목

ERD

ERD 보기

API

[API 인증 흐름](API 인증 흐름 링크)
[API 응답 규격](응답 규격 링크)
[에러 메세지 목록](에러 목록 링크)

프로젝트 도메인 테크스펙

도메인 테크스펙 바로가기

배포 환경 및 CI/CD 파이프라인

관련 구성 및 파이프라인 설명 작성

코드 품질 관리 도구

예시

도구	역할	목적
.editorconfig
Checkstyle
JaCoCo
Java Test Fixtures
SonarQube

Backend Wiki - 100-hours-a-week/16-Hot6-wiki GitHub Wiki

OnTheTop Backend Wiki

서비스 바로가기

목차

개발 일정

컨벤션 룰

1. 코드 스타일 가이드

2. CheckStyle 설정

3. 커밋 메시지 컨벤션

🔹 커밋 메시지 타입

🔹 커밋 메시지 형식

4. 추가 규칙

🔹 브랜치 기본 규칙

🔹 브랜치 작업 규칙

트러블 슈팅

ERD

API

프로젝트 도메인 테크스펙

배포 환경 및 CI/CD 파이프라인

코드 품질 관리 도구

⚠️ GitHub.com Fallback ⚠️

Backend Wiki - 100-hours-a-week/16-Hot6-wiki GitHub Wiki

OnTheTop Backend Wiki

서비스 바로가기

목차

개발 일정

컨벤션 룰

1. 코드 스타일 가이드

2. CheckStyle 설정

3. 커밋 메시지 컨벤션

🔹 커밋 메시지 타입

🔹 커밋 메시지 형식

4. 추가 규칙

🔹 브랜치 기본 규칙

🔹 브랜치 작업 규칙

트러블 슈팅

ERD

API

프로젝트 도메인 테크스펙

배포 환경 및 CI/CD 파이프라인

코드 품질 관리 도구

⚠️ **GitHub.com Fallback** ⚠️

⚠️ GitHub.com Fallback ⚠️