DR-0022: 테스트마다 ID(T-0001), 테스트 목록은 한국어로

배경

테스트 목록은 스크립트가 테스트 코드의 이름에서 만든다. 이름 앞에는 그 테스트가 확인하는 것의 ID(AT- · BUG- · R- …)를 적어 왔다. 메인테이너가 목록을 읽어 보니, 결함 하나를 테스트 둘이 확인하면 같은 ID가 두 줄에 나와 “ID는 유니크해야하지 않나요?”라는 물음이 났다. 다른 문서의 ID가 테스트의 ID처럼 보였고, 테스트를 따로 가리킬 이름은 없었다. 메인테이너: “ID가 있으면 어떤 테스트에 대해 정확하게 지목하고 논의를 할 수 있습니다.” 또 목록이 테스트 코드의 영어를 그대로 실었다. 메인테이너: “문서는 app과 달리 한국어가 기준입니다.” · “코드는 그대로 두세요. 문서에만 한국어로 번역해달라는 말입니다.”

결정 기준

  • 대화에서 테스트 하나를 정확히 가리킬 수 있다
  • ID는 바뀌지 않는다(파일을 옮기거나 영역을 다시 나눠도)
  • 코드는 영어 그대로(DR-0017), 문서는 한국어

검토한 대안

ID의 모양

  • T-0001 차례 번호(고름): 영역과 상관없는 한 줄의 번호. 파일이 다른 영역으로 가도 그대로다.
  • 영역 글자 + 번호(T-KEY-012): ID만 보고 영역을 알지만, 파일의 영역이 바뀌면 ID와 어긋난다.

범위

  • 모든 테스트(고름): 어느 테스트든 ID로 가리킨다. 목록에 모두 한 줄씩 싣는다.
  • 확인하는 것의 ID를 적은 테스트만: 나머지는 가리킬 수 없다.

한국어

  • 번역 표를 따로(고름): 테스트 코드는 영어 그대로, 목록에 실을 한국어는 src/scripts/test-list-ko.json. 나중에 영어판 문서를 만들면 코드의 글을 그대로 쓴다.
  • 테스트 이름을 한국어로: DR-0017과 어긋난다.

결정

  • 테스트마다 T-와 네 자리 번호의 ID를 이름 맨 앞에 둔다: T-0412: …, 확인하는 것이 있으면 T-0412 · BUG-03 · QA-19: …. 테스트에 ID가 없거나 겹치면 pnpm check가 실패한다.
  • ID는 바뀌지 않고 다시 쓰지 않는다. 다음 번호는 src/scripts/test-ids.json이 지킨다. 새 테스트는 src/에서 node scripts/test-list.mjs --assign-ids로 다음 번호를 받는다. 처음 매긴 번호는 목록의 차례(영역 → 유형 → 파일 → 파일 안의 차례)를 따른다(T-0001 ~ T-0519).
  • 이름 앞의 다른 ID(AT- · BUG- · R- · QA- · UX)는 그 테스트가 확인하는 것이다. 목록에서는 “확인하는 것” 칸에 둔다.
  • 목록은 영역 안에서 파일마다 제목 하나와 표 하나(ID · 테스트 · 확인하는 것)다. 파일의 설명 · 유형 · 방법 · 파일 전체가 확인하는 것은 제목 아래 한 줄에 한 번만 적는다.
  • 목록의 글은 한국어다. 번역이 빠지면 pnpm check가 실패하고, --add-missing이 빈 번역을 더한다.

결과

  • 좋아지는 점: “T-0278이 이상해요”처럼 테스트를 가리킨다. 결함을 확인하는 테스트는 “확인하는 것” 칸의 BUG-로 보이고, 테스트가 없는 결함은 목록의 끝에 나온다.
  • 감수하는 점: 테스트를 더할 때 ID와 번역을 함께 채운다. 테스트 이름이 조금 길어진다.
  • 후속 작업: 없음