ce-compound은(는) 무엇을 하나요?
최근에 해결한 문제를 문서화하여 팀의 지식을 축적하거나 프로젝트의 공유 도메인 용어집인 CONCEPTS.md에 기여합니다.
해야 할 일
다음 중 하나를 수행하세요:
- 사용자가 최근에 해결한 문제에 대해 설명하면, 그 내용을 간결한 진입 기록으로 문서화하여 팀의 지식 베이스(예:
CONCEPTS.md,docs/adrs/)에 저장합니다. - 프로젝트에
CONCEPTS.md가 없는 경우, 도메인 용어와 문제 해결 기록을 담은 초기 버전을 생성합니다.
형식
각 진입 기록은 다음을 포함해야 합니다:
- 문제: 해결한 문제에 대한 간결한 설명 (1-2문장)
- 해결 방법: 해결 방법에 대한 요약 (1-2문장)
- 결정 이유: 특정 접근 방식을 선택한 이유에 대한 간략한 설명 (선택 사항)
- 참고 자료: 관련 PR, 이슈, 또는 문서 링크 (선택 사항)
예시
## 2024-01-15: 로그인 타임아웃 버그 수정
- **문제**: 사용자 세션이 5분 후에 예기치 않게 만료되어 사용자 경험에 영향을 미쳤습니다.
- **해결 방법**: 세션 타임아웃 설정을 30분으로 늘리고, 만료 전에 사용자에게 경고를 표시하도록 변경했습니다.
- **결정 이유**: 보안 요구 사항과 사용자 편의성을 균형 있게 맞추기 위해 30분이 적절한 절충안이었습니다.
- **참고 자료**: [#123](https://github.com/example/pr/123)
팁
- 팀 전체에 가치가 있을 수 있는 문제를 문서화하는 데 집중하세요.
- 입력을 최소화하기 위해 템플릿을 미리 채우는 것을 주저하지 마세요.
- 항상 기존 지식 베이스에 새 기록을 추가하기 전에 먼저 확인하세요.
- 특이한 에지 케이스나 복잡한 기술적 결정은 특히 문서화할 가치가 있습니다.