Skip to content

Latest commit

 

History

History
61 lines (44 loc) · 3.03 KB

File metadata and controls

61 lines (44 loc) · 3.03 KB

AGENTS.md

이 저장소에서 AI 보조 개발을 수행할 때 따르는 규칙입니다.

상세 작업 흐름: ai/ai-assisted-development-workflow.md

구현 전 계획

  • 기능 추가, 리팩터링, 버그 수정 요청을 받더라도 바로 파일을 수정하지 않는다.
  • 먼저 기존 구조를 확인하고 다음 내용을 제시한다.
    • 해결하려는 문제
    • 변경이 필요한 파일
    • API, 데이터베이스, 호환성 영향
    • 필요한 테스트
    • 예상 리스크와 의도적으로 제외할 범위
  • 사용자가 즉시 구현을 명시적으로 요청하지 않았다면 승인 후 파일을 수정한다.

문서 작성 언어

  • 저장소에 추가하는 문서, 설계안, 구현 계획, 리뷰 요약은 한국어로 작성한다.
  • 외부 도구나 라이브러리의 고유 용어는 필요한 경우 원문을 병기할 수 있다.

변경 범위 제한

  • 승인된 계획에 필요한 파일만 수정한다.
  • 영향을 먼저 설명하지 않고 API 계약, 데이터베이스 스키마, 관련 없는 서식을 변경하지 않는다.
  • AI가 만들지 않은 변경을 되돌리거나 덮어쓰지 않는다.

Git 작업 제한

  • 사용자가 명시적으로 요청하지 않는 한 commit, push, merge, rebase를 수행하지 않는다.
  • 커밋이 필요해 보이면 먼저 변경 범위와 추천 커밋 메시지를 제안한다.
  • 사용자가 직접 커밋하거나 push하겠다고 말한 경우에는 명령을 실행하지 않고 필요한 확인 정보만 제공한다.

구현과 리뷰 분리

  • 구현 단계에서는 승인된 계획을 따르고 계획에서 벗어난 변경을 보고한다.
  • 리뷰 단계에서는 명시적으로 요청받지 않는 한 코드를 수정하지 않는다. 버그, 회귀 가능성, 누락된 테스트, 근거가 부족한 주장을 찾는다.
  • AI가 생성한 코드는 테스트와 사람의 리뷰로 확인하기 전까지 신뢰하지 않는다.

Review guidelines

Codex GitHub Code Review가 PR 리뷰에서 따라야 할 기준이다.

  • 리뷰 코멘트는 한국어로 작성한다.
  • 각 코멘트는 심각도, 문제 상황, 위험, 수정 방향을 짧게 포함한다.
  • 트랜잭션 경계와 부분 실패 가능성을 확인한다.
  • 비동기 작업의 유실, 중복 처리, 재시도 경로를 확인한다.
  • API와 데이터베이스 호환성 회귀를 확인한다.
  • 누락된 테스트와 근거가 부족한 성능 주장을 확인한다.
  • AI 워크플로우 문서를 리뷰할 때는 과장된 성과 표현, 비밀 정보 노출 위험, 실제 구현 전 주장된 자동화 여부를 확인한다.
  • 사소한 서식보다 기능 오류와 운영 리스크를 우선한다.

판단 기록

  • PR에 다음 내용을 정리한다.
    • AI를 사용한 범위
    • 채택하거나 기각한 제안
    • 수행한 검증
    • 남은 리스크
  • 비밀 정보, 인증 정보, 개인정보, 관련 없는 대화가 포함될 수 있는 원본 프롬프트와 도구 실행 로그를 커밋하지 않는다.