33 lines
1.5 KiB
Markdown
33 lines
1.5 KiB
Markdown
# 기여 가이드
|
|
|
|
## 변경 원칙
|
|
|
|
1. 변경 대상의 소유 디렉터리를 먼저 확인합니다.
|
|
2. 재사용 가능한 구현은 catalog 영역에, 환경별 조합과 차이만 live/cluster
|
|
진입점에 둡니다.
|
|
3. 하나의 리소스는 하나의 도구와 하나의 디렉터리만 소유합니다.
|
|
4. 운영 변경에는 영향 범위, 롤백 방법, 검증 결과를 함께 기록합니다.
|
|
5. `make check`를 통과한 변경만 리뷰를 요청합니다.
|
|
|
|
## 이름 규칙
|
|
|
|
- 폴더와 리소스: 소문자 `kebab-case`
|
|
- 환경: `dev`, `staging`, `prod`처럼 조직에서 합의한 고정 어휘
|
|
- 클러스터: 환경과 위치를 식별할 수 있는 안정적인 이름
|
|
- 임시 이름, 사람 이름, 티켓 번호를 장기 리소스 이름에 사용하지 않음
|
|
|
|
## Pull request 체크리스트
|
|
|
|
- [ ] 변경이 올바른 소유권 경계에 위치한다.
|
|
- [ ] 비밀, kubeconfig, state, plan 파일이 포함되지 않았다.
|
|
- [ ] 공급자, module, chart, image 버전 변경의 영향을 확인했다.
|
|
- [ ] `make check` 결과를 확인했다.
|
|
- [ ] 운영 영향이 있으면 rollback/runbook을 갱신했다.
|
|
- [ ] 구조적 선택이 바뀌면 ADR을 추가하거나 갱신했다.
|
|
|
|
## 배포
|
|
|
|
이 템플릿에는 범용 `apply` 또는 `destroy` 명령이 없습니다. 프로젝트에서 배포
|
|
자동화를 추가할 때는 대상 환경을 필수 입력으로 받고, 운영 환경에는 승인과
|
|
동시 실행 잠금을 적용하며, 검토된 plan만 적용하도록 설계합니다.
|