-
Notifications
You must be signed in to change notification settings - Fork 0
Backend Wiki
김동건 edited this page Mar 18, 2026
·
14 revisions
| 기간 | 주요 작업 |
|---|---|
| 1/19~2/1 | MVP 개발 |
| 2/2~2/8 | 1차 배포 및 출시 |
| 2/9~3/1 ~ | V2 개발 |
| 3/2~3/22 ~ | V3 개발 |
| 3/23~3/26 ~ | 문서 정리 |
# 컨벤션 룰
| 설정 항목 | 값 | 설명 |
|---|---|---|
| charset | utf-8 | 파일 인코딩을 UTF-8로 통일 |
| end_of_line | lf | 줄 끝 문자를 LF(Unix 방식)로 통일 |
| indent_style | space | 들여쓰기는 탭 대신 공백 사용 |
| insert_final_newline | true | 파일 마지막에 빈 줄 삽입 |
| trim_trailing_whitespace | true | 줄 끝 불필요한 공백 자동 제거 |
| max_line_length | 120 | 한 줄 최대 120자 제한 |
| 항목 | 규칙 | 설명 |
|---|---|---|
| 클래스명 | PascalCase | 각 단어의 첫 글자를 대문자로 작성 (예: UserService) |
| 변수명 및 메서드명 | camelCase | 첫 단어 소문자, 이후 단어 첫 글자 대문자 (예: getUserById) |
| 상수명 | UPPER_SNAKE_CASE | 모두 대문자, 단어 구분은 언더스코어 (예: MAX_RETRY_COUNT) |
| 패키지명 | 소문자 (lowercase) | 모두 소문자로만 구성 (예: com.caro.bizkit.domain) |
| 탭 사용 | space 4칸 | 탭 문자 대신 공백 4칸으로 들여쓰기 |
| 줄 바꿈 | 120자 초과 시 줄 바꿈 | 가독성을 위해 120자를 초과하면 줄 나눔 |
| 최대 라인 길이 | 120 | 코드 스타일 가이드와 동일하게 적용 |
제어문 블록 {}
|
항상 사용 |
if/for/while 한 줄이어도 중괄호 생략 금지 |
| 연산자 배치 | 줄 끝에 두지 않음 | 줄 바꿈 시 연산자는 다음 줄 앞에 위치 |
| import 순서 |
java → javax → org → com → 프로젝트 내부 |
표준 라이브러리부터 내부 패키지 순으로 정렬 |
| 주석 스타일 |
// 한 줄, /** */ 블록 |
공개 API 및 복잡한 로직에는 Javadoc 블록 주석 필수 |
type: summary
changes:
- 변경 사항 1
- 변경 사항 2
| 타입 | 설명 |
|---|---|
feat |
새로운 기능 추가 |
fix |
버그 수정 |
refactor |
기능 변경 없는 코드 리팩토링 |
docs |
문서 수정 |
test |
테스트 코드 추가 및 수정 |
chore |
빌드 설정, 패키지 등 기타 작업 |
deploy |
배포 관련 작업 |
-
type:뒤에 공백 1칸 -
summary는 핵심만 간결하게 작성 - 마침표(
.) 사용 금지 - 72자 이내로 작성
feat: 로그인 기능 추가
changes:
- 로그인 API 구현
- JWT 발급 로직 추가
- application.yml cors 설정 추가
<type>(<scope>): <기능 완료 범위>
예시
feat(auth): 로그인 및 토큰 발급까지 동작
fix(search): 빈 키워드 예외 처리까지 완료
#### 요약
- 무엇을 했는지 2~3줄 요약
#### 완료 범위 (필수)
- 어디까지 동작하는지 명확히 작성
- 남은 작업 (TODO)
#### 변경 내용
- 핵심 변경 사항 3~6개
#### 테스트/검증
- 로컬 / 스테이징 / 로그 등 검증 방법
#### 영향/주의 (선택)
- 배포, 환경변수, 마이그레이션 등 주의사항Release: v<MAJOR>.<MINOR>.<PATCH>
| 구분 | 기준 | 예시 |
|---|---|---|
| MAJOR | 하위 호환이 깨지는 변경 (예: API 스펙 변경) | v1.0.0 |
| MINOR | 기능 추가 (하위 호환 유지) | v0.4.0 |
| PATCH | 버그 수정 / 리팩토링 | v0.3.2 |
v0 운영 기준: 큰 변경도 일단 MINOR로 처리하며, 정식 안정화 시 MAJOR 증가
예시
Release: v0.3.2 → 버그 수정
Release: v0.4.0 → 기능 추가
Release: v1.0.0 → 정식 릴리즈
- PR은 하나의 목적만 가진다
- PR 제목은 커밋 메시지 규칙과 동일하게 작성
- 코드 리뷰 후 머지