docs(agent-guides): 작업 절차와 문서 유지보수 규칙을 정리한다
This commit is contained in:
15
docs/20260429_연속작업계획문서재사용규칙.md
Normal file
15
docs/20260429_연속작업계획문서재사용규칙.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# 20260429 연속 작업 계획 문서 재사용 규칙
|
||||||
|
|
||||||
|
## 구현 계획
|
||||||
|
- [x] 작업 계획 문서 생성과 관련된 기존 규칙 위치를 확인한다.
|
||||||
|
- [x] 연속된 하나의 작업일 때는 새 계획 문서를 만들지 않고 기존 문서에 이어서 기록하는 규칙을 추가한다.
|
||||||
|
- [x] 관련 문서 간 표현과 의도를 일치시킨다.
|
||||||
|
- [x] 문서 진단과 검증 결과를 기록한다.
|
||||||
|
|
||||||
|
## 검증 기록
|
||||||
|
- [x] 작업 완료 후 검증 결과를 기록한다.
|
||||||
|
|
||||||
|
- 1차 구현
|
||||||
|
- 무엇을: `AGENTS.md`의 `작업 계획 문서 규칙 (docs)`에 연속된 하나의 작업이라면 새 계획 문서를 만들지 않고 기존 계획 문서에 작업 항목과 검증 기록을 이어서 추가한다는 규칙을 넣었다. 함께 `docs/agent-guides/작업절차.md`와 `docs/agent-guides/문서유지보수.md`에도 같은 취지의 보완 문구를 추가해 실행 흐름과 문서 정책이 일치하도록 정리했다.
|
||||||
|
- 왜: 같은 작업의 후속 수정마다 새 계획 문서가 계속 생성되면 문서 수가 불필요하게 늘어나고, 작업 이력도 여러 파일로 흩어져 관리와 탐색이 어려워지기 때문이다.
|
||||||
|
- 어떻게: `read`로 세 문서의 해당 섹션을 다시 확인해 문구 위치와 의미 일치를 검토했고, `lsp_diagnostics`로 `AGENTS.md`, `docs/agent-guides/작업절차.md`, `docs/agent-guides/문서유지보수.md`, `docs/20260429_연속작업계획문서재사용규칙.md`에 대해 모두 `No diagnostics found`를 확인했다. 추가로 `./gradlew tasks --all` 실행 결과 `BUILD SUCCESSFUL`을 확인했다.
|
||||||
12
docs/agent-guides/문서유지보수.md
Normal file
12
docs/agent-guides/문서유지보수.md
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# 문서 유지보수
|
||||||
|
|
||||||
|
## 문서 유지보수 규칙
|
||||||
|
- `build.gradle.kts` 변경 시 실행 명령 섹션을 함께 갱신한다.
|
||||||
|
- 테스트 클래스 추가/이동 시 단일 테스트 실행 예시를 최신 상태로 유지한다.
|
||||||
|
- `.editorconfig` 변경 시 포맷 규칙 섹션을 동기화한다.
|
||||||
|
- Cursor/Copilot 규칙 파일이 생기면 해당 내용을 이 문서에 반영한다.
|
||||||
|
- 연속된 하나의 작업에 대해 계획 문서가 여러 개 생기지 않도록 기존 계획 문서 재사용 여부를 먼저 확인한다.
|
||||||
|
- 문서 변경 후 최소 한 번 `./gradlew tasks --all`로 명령 유효성을 확인한다.
|
||||||
|
- 불확실한 규칙은 추측으로 채우지 말고 근거 파일 경로를 먼저 확인한다.
|
||||||
|
- 에이전트 안내 문구는 한국어 중심으로 유지한다.
|
||||||
|
- 커밋 규칙 예시는 팀 컨벤션 변경 시 즉시 업데이트한다.
|
||||||
9
docs/agent-guides/작업절차.md
Normal file
9
docs/agent-guides/작업절차.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# 작업 절차
|
||||||
|
|
||||||
|
## 작업 절차 체크리스트
|
||||||
|
- 변경 전: 유사 기능 코드를 먼저 찾아 네이밍/예외/응답 패턴을 맞춘다.
|
||||||
|
- 변경 전: 같은 작업의 연속 후속 수정인지 먼저 확인하고, 연속 작업이면 새 계획 문서를 만들지 말고 기존 계획 문서를 갱신한다.
|
||||||
|
- 변경 중: 공개 API 스키마를 임의 변경하지 말고, 작은 단위로 안전하게 수정한다.
|
||||||
|
- 변경 후: 최소 단일 테스트 또는 `./gradlew test`를 실행하고, 필요 시 `./gradlew ktlintCheck`를 수행한다.
|
||||||
|
- 커밋 전/후: `commit-policy` 스킬을 먼저 로드하고, `git commit` 직전과 직후에 `work/scripts/check-commit-message-rules.sh`를 실행해 커밋 메시지 규칙 준수 여부를 확인한다.
|
||||||
|
- 커밋 전/후 확인 시 Sisyphus attribution footer가 없는지 함께 검증한다.
|
||||||
Reference in New Issue
Block a user