[Spring 프로젝트] 개발 가이드

개발 가이드

해당 문서는 Spring 프로젝트 팀원들과 개발 관련 형식(Pull Request, Commit 등)을 맞추기 위한 가이드 문서입니다.

---

Pull Request 가이드

PR을 날릴 때에는 코드리뷰에 용이하도록 모듈/기능별로 쪼개서 하도록 합니다.
코드리뷰를 봐주는 사람들이 로직을 전부 이해하고 있지 않으므로 각 서비스를 왜 추가했는지, 어떤 용도로 사용하는 것인지 간단하게라도 작성해주시면 좋습니다.

코드리뷰는 프로젝트 팀원들이 모인 토요일에 모여서 확인하고 리뷰를 하고 각 기능별 브랜치에서 master로 머지합니다. 즉, 모임 시간 이전까지는 개발을 마치고 PR을 날리고 와주세요. 어차피 출시를 위해서 달리고 있는 것도 아니라 개발한 기능이 별로 없더라도 상관 없습니다. (리뷰어들은 오히려 좋아할거에요)

된 것까지만 올려주세요. 단 코드에 에러가 없는지 꼭 확인 후 올려주세요.

PR 형식은 다음과 같습니다.

[Module] PR Title // PR의 중요 내용을 축약해서 작성해주세요.

Summary
- 이 PR이 어떤 내용인지 요약해서 작성합니다.

Fix
- 고친 내용의 커밋 메세지 (or 주요 기능/내용)
  - 고친 내용의 커밋 메세지 Detail
Feature
- 새로 만든 내용의 커밋 메세지 (or 주요 기능/내용)
  - 새로 만든 내용의 커밋메세지 Detail
Enhancement
- 강화된 내용의 커밋 메세지 (or 주요 기능/내용)
  - 강화된 내용의 커밋메세지 detail

---

Commit 가이드

Commit 제목 가이드

[서비스이름][수행내용종류] 나머지 제목

• 서비스이름 : 실제 서비스 이름, 없으면 생략 가능
  • 예) User, Study, Common 등
• 수행내용종류 : 필수 입력
  • Feat : (Feature) 새 기능 추가
  • Enhancement : 기능 업그레이드
  • Fix : (BugFix) 버그 픽스
  • Cleanup : 리팩토링 등 코드 정리 작업
  • Test : 테스트 관련 코드
  • Doc : (Documentation) 문서 관련
  • Build : 빌드 관련

Commit 작성 시 유의 사항

• 한글 사용 가능
• 제목은 50자 이내, 제목과 본문을 빈 행으로 구분
• How 보다는 What, Why를 명시
• 여러 작업을 하나의 Commit으로 하거나, 하나의 작업을 여러 Commit으로 하지 않는다.
• 하나의 Commit은 이유와 목적이 명확해야 한다.