sodalive-android/docs/20260224_AGENTS문서정비.md

AGENTS 문서 정비 계획

구현 체크리스트

• 저장소의 빌드/린트/테스트 실행 명령 근거 파일 수집
• 단일 테스트 실행 명령(클래스/메서드 단위) 근거 확인
• 코드 스타일 규칙(포맷/타입/네이밍/에러 처리/import) 근거 수집
• 기존 AGENTS.md 존재 여부 확인 및 개선/신규 작성 방향 결정
• Cursor/Copilot 규칙 파일 존재 여부 확인 및 반영
• AGENTS.md 약 150줄로 작성/갱신
• 설정/보안 유의사항 섹션을 현재 프로젝트 민감 항목 기준으로 채우기
• AGENTS.md 내용이 현재 프로젝트 설정(settings.gradle, app/build.gradle, .editorconfig)과 일치하는지 재검증
• 사용자 추가 요청 반영: AGENTS.md 전면 한글화 및 향후 문서 한글 작성 규칙 명시
• 최소 1회 빌드 시스템 명령 유효성 확인

작업 메모

• 본 문서는 요청된 문서 유지보수 규칙에 따라 작업 시작 시점에 생성한다.
• 구현 중 범위 변경이 발생하면 체크리스트를 먼저 갱신한다.

검증 기록

• 검증 #1
  • 무엇: 문서 파일 문법/형식 진단
  • 왜: 문서 수정 후 오류 여부를 즉시 확인하기 위해
  • 어떻게: lsp_diagnostics로 AGENTS.md, docs/20260224_AGENTS문서정비.md 검사
  • 결과: 오류 없음
• 검증 #2
  • 무엇: 빌드 시스템 명령 유효성
  • 왜: 문서 규칙(문서 변경 후 최소 1회 빌드 시스템 명령 실행) 충족을 위해
  • 어떻게: ./gradlew :app:help 실행
  • 결과: BUILD SUCCESSFUL
• 검증 #3
  • 무엇: 단일 테스트 실행 명령 유효성
  • 왜: AGENTS.md의 단일 테스트 실행 가이드가 실제로 동작하는지 확인하기 위해
  • 어떻게: ./gradlew :app:testDebugUnitTest --tests "kr.co.vividnext.sodalive.chat.talk.room.TimeUtilsTest" 실행
  • 결과: BUILD SUCCESSFUL (테스트 태스크 up-to-date)
• 검증 #4
  • 무엇: AGENTS.md 내용의 현재 프로젝트 적합성 점검
  • 왜: 요청사항(현재 프로젝트에 맞는지 확인)을 충족하기 위해
  • 어떻게: settings.gradle, build.gradle, app/build.gradle, .editorconfig, app/src/main/AndroidManifest.xml을 재확인하고 명령/규칙 문구를 대조
  • 결과: :app 단일 모듈, lint.checkReleaseBuilds false, import-ordering 비활성화, 권한/보안 주의 항목 반영 완료
• 검증 #5
  • 무엇: 문서 변경 후 Gradle 명령 유효성 재확인
  • 왜: 문서 유지보수 규칙(문서 변경 후 ./gradlew tasks --all)을 충족하기 위해
  • 어떻게: ./gradlew tasks --all 실행
  • 결과: BUILD SUCCESSFUL
• 검증 #6
  • 무엇: 단일 테스트 가이드 재검증
  • 왜: AGENTS.md 단일 테스트 예시의 최신 유효성을 다시 확인하기 위해
  • 어떻게: ./gradlew :app:testDebugUnitTest --tests "kr.co.vividnext.sodalive.chat.talk.room.TimeUtilsTest" 실행
  • 결과: BUILD SUCCESSFUL (:app:testDebugUnitTest UP-TO-DATE)
• 검증 #7
  • 무엇: 최종 문서 진단
  • 왜: 수정 완료 직후 문서 상태를 확인하기 위해
  • 어떻게: lsp_diagnostics로 AGENTS.md, docs/20260224_AGENTS문서정비.md 검사
  • 결과: 오류 없음