Skip to content

작업 매뉴얼

Jeonghwa Heo edited this page Jun 4, 2023 · 3 revisions

개발 flow

  1. Issues 탭에서 이슈를 생성한다.
  • 체크박스로 작업 내역을 기록한다.
  1. develop 브랜치에서 작업 브랜치를 생성한다.
  • feature/[issue number]-[task name]
  1. 작업 완료 후, 작업 브랜치 ➡️ develop으로 PR을 생성한다.
  2. PR승인 시 develop ➡️ master 브랜치로 fast forward를 통해 머지한다.

commit message 컨벤션

  • 커밋 내용에 맞게 아래 포맷으로 커밋 메시지를 작성한다.
- `feat` : 새로운 기능 추가
- `fix` : 버그 수정
- `docs` : 문서 수정
- `style` : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
- `refactor` : 코드 리펙토링
- `test` : 테스트 코드, 리펙토링 테스트 코드 추가
- `chore` : 빌드 업무 수정, 패키지 매니저 수정

- 예시
feat: "회원 가입 기능 구현"

SMS, 이메일 중복확인 API 개발

Related: #2

PR 컨벤션

  • 프로젝트에 설정된 템플릿 규약에 맞게 작성한다.
## 개요
내용을 적어주세요.

## 작업사항
- 내용을 적어주세요.

## 변경로직
- 내용을 적어주세요.

코드컨벤션

  • 구글 체크 스타일 선택
    • config패키지의 google-checkstyle.xml 적용
  • 인텔리제이 세팅 확인 (Editor → Code Style → GoogleStyle)
    • Use tab character 해제
    • Tab size: 2
    • Indent: 2
    • Continuation Indent: 4
    • Label Indent: 0