Coding Convention

Coding Convention

Git & GitHub

• git-flow 전략을 사용
  • https://techblog.woowahan.com/2553/
  • https://overcome-the-limits.tistory.com/7

Branch

• GitHub Issues + IntelliJ Task 사용
• feature/#1-기능명
  • ex) feature/#1-전역예외처리

Commit & Pull Request Rules

init: 초기 설정
feature: 새로운 기능 추가
fix: 버그 수정
docs: 문서 수정
refactor: 리팩토링
test: 테스트 코드
chore: 코드 내 설정부분 수정(ex, properties)

• GitHub issues + Project 사용
• [#이슈번호] Title(기능 정의): Body(내용이 길면 개행)
  • ex) [#102] feat(예외처리): Bookmark 예외처리
  • ex) [#82] refactor(코드 리팩토링): (개행)
  • -Bookmark Controller
  • -Folder Controller

Code Format

• IntelliJ IDEA에서 제공하는 코드 자동 포매팅 사용(Mac기준 Option + Command + L)
• Code Style는 Google Java Style Guide를 따라 작성