patchwork로 코드베이스 컨벤션 문서 자동화하기
중급35분6시간 전
행사 운영 예시 코드베이스를 대상으로 patchwork를 설치하고 스캔한 뒤, 코드의 네이밍·테스트·오류 처리 규칙을 정리하고 AI 에이전트가 읽을 MCP 설정까지 구성합니다. 최종적으로 CONVENTIONS.md, patchwork-scan.txt, .mcp/patchwork.json, docs/patchwork-check-example.py로 이루어진 규칙 문서화 파일 세트를 만듭니다.
이 실습은 터미널에서 진행됩니다
오른쪽 패널에서 설치 명령어를 복사하세요이런 걸 배워요
- AI 코딩 도구가 참고할 프로젝트 규칙 문서를 만들 수 있습니다
- patchwork scan으로 코드베이스의 네이밍과 테스트 패턴을 요약할 수 있습니다
- MCP 설정 JSON으로 AI 에이전트가 프로젝트 규칙을 읽을 준비를 할 수 있습니다
- 행사 운영 코드 예시를 회사 코드베이스 규칙 문서화 흐름으로 바꿔 적용할 수 있습니다
어떻게 진행해요
1. 환경 확인하기
2. 행사 운영 코드 예시 만들기
3. patchwork 설치하기
4. 코드 규칙 스캔하기
5. CONVENTIONS.md 작성하기
6. MCP 설정 파일 만들기
7. 중요 함수 규칙 표시하기
8. 산출물 검증하기
AI 튜터가 각 단계를 하나씩 안내해줄 거예요