Codex·범용 에이전트를 위한 AGENTS.md 작성하기

언제 사용하나

여러 코딩 에이전트가 공통으로 읽는 표준 지침 파일(AGENTS.md)이 필요할 때.

작성 전 확인

• 저장소 구조와 실행/테스트 방법, 안전 규칙을 정리한다.

복사해서 쓰는 템플릿 (AGENTS.md)

# 에이전트 작업 지침

## 프로젝트 개요
{{OVERVIEW}}

## 개발 환경
- 설치: `{{SETUP_CMD}}`
- 실행: `{{RUN_CMD}}`
- 테스트: `{{TEST_CMD}}`

## 작업 규칙
- 변경 범위를 최소화한다.
- 커밋 전 테스트를 통과시킨다.
- {{RULES}}

## 금지
- {{FORBIDDEN}}

placeholder 설명

• {{OVERVIEW}} : 프로젝트 개요
• {{SETUP_CMD}} / {{RUN_CMD}} / {{TEST_CMD}} : 명령
• {{RULES}} / {{FORBIDDEN}} : 규칙/금지

입력 예시

{{TEST_CMD}} = npm test

기대 결과

도구가 달라도 일관되게 참조하는 표준 지침.

검증 방법

에이전트가 AGENTS.md의 명령·규칙대로 동작하는지 확인한다.

주의사항과 흔한 실수

• 여러 하위 폴더가 있으면 각 폴더에 맞는 AGENTS.md를 둘 수 있다.
• 존재하지 않는 명령을 적지 않는다.

관련 문서

• AGENTS.md 규격: https://agents.md/