ReadingFrame-Server

📌 Commit Message Convention

feat: 새로운 기능 구현

test: 테스트 코드를 추가하거나 수정하는 경우

refactor: 코드의 리팩토링

fix: 버그 관련 수정

rename: 파일명 또는 폴더명을 수정한 경우

move: 파일을 이동한 경우

remove: 파일을 삭제한 경우

comment: 필요한 주석 추가 및 변경

style: (코드의 수정 없이) 코드 포맷 변경, 세미콜론 누락 수정 등

docs: 문서를 수정한 경우

chore: build 관련, 패키지 매니저 등 자잘한 수정

ex) feat: commit message

📌 Test Code Convention

• 테스트 코드 작성 시 JUnit5, assertJ 라이브러리를 사용합니다.
• @DisplayName을 통해 해당 테스트가 무슨 테스트인지 작성합니다.
• 단위 테스트로 진행하며, given, when, then의 구조로 작성합니다.
  • given : 테스트 수행을 위한 사전 조건 세팅
    
  • when : 테스트 수행 로직
    
  • then : 테스트 결과 검증

// 테스트 코드 예시

// 기본 사용법
// import org.assertj.core.api.Assertions;

// 정적 import를 통해 더 간단하게 작성 할 수 있습니다.
import static org.assertj.core.api.Assertions.assertThat;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.DisplayName;

class BookRecordTest {
    @Test
    @DisplayName("독서노트의 키워드 리뷰 변경 테스트")
    void changeKeywordReview() {
        // given
        BookRecord bookRecord = BookRecord.create( ... );

        // when
        bookRecord.setKeyword("재밌는 책");

        // then
        assertThat(bookRecord.getKeyword()).isEqualTo("재밌는 책");
}