이 스킬은 사용자가 리팩터링 요청을 생성하려 할 때 호출됩니다. 아래 단계를 순서대로 진행하되, 필요하지 않다고 판단되는 단계는 건너뛸 수 있습니다.
-
사용자에게 해결하려는 문제와 잠재적 해결 방안에 대한 길고 상세한 설명을 요청하세요.
-
저장소를 탐색하여 사용자의 주장을 확인하고 코드베이스의 현재 상태를 이해하세요.
-
다른 옵션을 고려했는지 사용자에게 묻고, 다른 옵션을 제시하세요.
-
구현에 대해 사용자와 인터뷰하세요. 매우 상세하고 철저하게 진행하세요.
-
구현의 정확한 범위를 확정하세요. 변경할 사항과 변경하지 않을 사항을 명확히 하세요.
-
코드베이스에서 이 영역의 테스트 커버리지를 확인하세요. 테스트 커버리지가 충분하지 않다면 사용자에게 테스트 계획에 대해 질문하세요.
-
구현을 아주 작은 커밋 단위로 분할하세요. Martin Fowler의 조언인 "각 리팩터링 단계를 가능한 한 작게 만들어 항상 프로그램이 작동하는 상태를 볼 수 있게 하라"는 점을 기억하세요.
-
리팩터링 계획이 담긴 GitHub 이슈를 생성하세요. 이슈 설명에는 다음 템플릿을 사용하세요:
문제 설명
개발자가 직면한 문제를 개발자의 관점에서 서술합니다.
솔루션
문제에 대한 솔루션을 개발자의 관점에서 서술합니다.
커밋
길고 상세한 구현 계획입니다. 계획을 평이한 영어로 작성하고, 구현을 가능한 가장 작은 커밋 단위로 분할하세요. 각 커밋은 코드베이스를 작동 가능한 상태로 유지해야 합니다.
결정 문서
내려진 구현 결정 사항 목록입니다. 여기에는 다음이 포함될 수 있습니다:
- 빌드 또는 수정될 모듈
- 수정될 모듈의 인터페이스
- 개발자의 기술적 설명
- 아키텍처 결정
- 스키마 변경 사항
- API 계약
- 특정 상호작용
특정 파일 경로나 코드 스니펫은 포함하지 마세요. 이들은 빠르게 구식이 될 수 있습니다.
테스트 결정 사항
내려진 테스트 관련 결정 사항 목록입니다. 다음을 포함하세요:
- 좋은 테스트의 정의 (외부 동작만 테스트하고 구현 세부사항은 테스트하지 않음)
- 테스트할 모듈
- 테스트의 선례 (즉, 코드베이스 내 유사한 유형의 테스트)
범위 외
이 리팩터링에서 범위를 벗어난 사항에 대한 설명입니다.
추가 노트 (선택 사항)
리팩터링에 관한 추가 노트입니다.