WeGrus-BE-Spring

SW 프로그래밍 동아리 IGRUS 웹사이트 제작 프로젝트
Explore the Organization

Report Bug · Request Feature

About

Directory Structure

/src.main.java.wegrus.clubwebsite
├── /advice
│ ├── GlobalExceptionHandler.java
├── /config
├── /controller
├── /dto
│ ├── /error
│ │ ├── ErrorCode.java
│ │ └── ErrorResponse.java
│ ├── /result
│ │ ├── ResultCode.java
│ │ └── ResultResponse.java
├── /entity
├── /exception
├── /repository
├── /service
├── /util
├── /vo
│ ClubWebsiteApplication.java

Commit Convention

Type: Subject
ex) Feat: 회원가입 API 추가

Description

Footer 
ex) Resolves: #1, #2

• Type
  • Feat: 기능 추가, 삭제, 변경
  • Fix: 버그 수정
  • Refactor: 코드 리팩토링
  • Style: 코드 형식, 정렬 등의 변경. 동작에 영향 x
  • Test: 테스트 코드 추가, 삭제 변경
  • Docs: 문서 추가 삭제 변경. 코드 수정 x
  • Etc: 위에 해당하지 않는 모든 변경
• Description
  • 한 줄당 72자 이내로 작성
  • 최대한 상세히 작성(why - what)
• Footer
  • Resolve(s): Issue 해결 시 사용
  • See Also: 참고할 Issue 있을 시 사용
• Rules
  • 관련된 코드끼리 나누어 Commit
  • 불필요한 Commit 지양
  • 제목은 명령조로 작성

Database Convention

• Common
  • 소문자 사용
  • 단어를 임의로 축약 x
  • 동사는 능동태 사용
• Table
  • 복수형 사용
  • 교차 테이블(Many to Many): 각 테이블 이름을 _(underscore)로 연결 -> Snake case

    ex) vip_members

• Column
  • PK, FK는 해당 테이블의 단수명_id으로 사용
  • boolean 유형은 _flag 접미어 사용
  • datetime 유형은 _date 접미어 사용

Collaborative Flow

1. New Issue
2. Create Branch
3. Commit Code
4. Pull Request
   • 가능한 기능별로 나누어서 PR하기
5. Code Review
6. Merge
7. Delete Branch

Contributors

김선필 💻

이도경 💻