[MD.SAVE]by PackWink

AGENTS.MD GUIDE

에이전트가 실제로 따르는 AGENTS.md 작성법

프로젝트 설명보다 실행 명령, 범위, 금지 사항과 완료 조건을 명확히 적는 데 집중하세요.

권장 구성

  1. 저장소 목적과 주요 디렉터리를 짧게 설명합니다.
  2. 설치, 개발, 테스트, 린트와 빌드 명령을 그대로 실행할 수 있게 적습니다.
  3. 코딩 규칙과 수정하면 안 되는 파일·데이터를 구체적으로 구분합니다.
  4. 작업 완료 전에 통과해야 할 검증과 보고할 내용을 정의합니다.

모호함을 줄이는 문장

  • “테스트를 잘 실행”보다 “변경 후 `npm test`와 `npm run lint` 실행”처럼 씁니다.
  • 규칙의 적용 범위가 하위 디렉터리마다 다르면 경로를 함께 적습니다.
  • 비밀값, 운영 데이터, 배포 권한처럼 중요한 경계는 별도 항목으로 둡니다.

루트 파일과 하위 폴더 규칙을 나누는 법

루트 AGENTS.md에는 저장소 전체의 명령과 금지 사항을 둡니다. 웹과 확장 프로그램처럼 검증 방법이 다른 폴더에는 더 가까운 AGENTS.md를 두고 그 경로에서만 필요한 규칙을 적습니다. 같은 명령을 여러 파일에 복사하면 한 곳만 갱신돼 충돌하기 쉽습니다.

규칙을 확인 가능한 문장으로 바꾸기

  • “모바일도 고려” 대신 “390px에서 가로 넘침과 CTA를 확인”이라고 씁니다.
  • “문서를 최신화” 대신 수정해야 할 파일과 기준 소스를 적습니다.
  • “다른 코드를 건드리지 않기” 대신 허용된 저장소 경로를 명시합니다.
  • 완료 조건에는 명령뿐 아니라 실제 URL이나 결과물을 확인하는 방법을 넣습니다.

템플릿에서 시작하기

AI 문서 템플릿에서 한국어 또는 영어 AGENTS.md를 불러온 뒤 저장소에 맞는 명령과 완료 조건으로 교체하세요.

이어서 읽기