From a2f84111cc74688726d2944c38e984054abb581d Mon Sep 17 00:00:00 2001 From: Klaus Date: Mon, 16 Mar 2026 15:25:25 +0900 Subject: [PATCH] =?UTF-8?q?docs(agent-rules):=20=ED=85=8C=EC=8A=A4?= =?UTF-8?q?=ED=8A=B8=EC=99=80=20=EC=A3=BC=EC=84=9D=20=EC=9E=91=EC=84=B1=20?= =?UTF-8?q?=EA=B7=9C=EC=B9=99=EC=9D=84=20=EB=B3=B4=EA=B0=95=ED=95=9C?= =?UTF-8?q?=EB=8B=A4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- AGENTS.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 8fac2538..a679c05e 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -83,11 +83,19 @@ - 생성자 주입(primary constructor + `private val`)을 기본으로 사용한다. - 필드 주입보다 명시적 생성자 주입을 우선한다. +### 10) 주석 +- 의미 단위별로 주석을 작성한다. +- 주석은 한 문장으로 간결하게 작성한다. +- 주석은 코드의 의도와 구조를 설명한다. +- 주석은 코드 변경 시 업데이트를 잊지 않는다. + ## 테스트 스타일 규칙 - 테스트 프레임워크: JUnit 5 (`useJUnitPlatform()`) - 목킹: Mockito 사용 패턴 존재 (`Mockito.mock`, ``Mockito.`when`(...)``) - 검증: `assertEquals`, `assertThrows` 패턴 준수. - 테스트 이름은 의도가 드러나는 영어 문장형(`should...`)을 유지한다. +- 테스트는 DisplayName으로 한국어 설명을 추가한다. +- 예외 상황이 있는지 확인하고 예외 상황에 대한 테스트 케이스를 추가한다. ## 설정/보안 유의사항 - `application.yml`은 다수의 `${ENV_VAR}`를 사용한다.