협업 자동화: .github 디렉토리
프로젝트 루트에 .github 디렉토리를 만들면, GitHub가 제공하는 다양한 자동화·커뮤니케이션 기능을 쓸 수 있습니다.
CODEOWNERS: 담당자 자동 지정
특정 파일이나 디렉토리에 책임자를 지정해두면, 그 파일이 바뀔 때마다 담당자가 리뷰어로 자동 할당됩니다. Branch protection과 함께 쓰면 담당자 승인 없이는 머지가 안 되도록 강제할 수도 있습니다.
.github/CODEOWNERS 파일 예시:
# 특정 파일에 대한 책임자 지정
README.md @username
# 디렉토리 전체에 대한 책임자 지정
/docs/ @organization/doc-team
# 패턴을 통한 책임자 지정
/src/* @organization/python-team
# 레포지토리의 모든 코드에 대한 책임자 지정
* @username여기 적힌 @username이나 팀은 반드시 저장소의 Collaborator로 등록되어 있어야 동작합니다. (팀 지정은 organization 저장소에서만 가능합니다.)
PR 템플릿: 리뷰를 위한 공통 양식
.github/PULL_REQUEST_TEMPLATE.md 파일을 만들어두면, 누군가 PR을 생성할 때 이 내용이 자동으로 채워집니다. 여러 종류의 템플릿이 필요하면 .github/PULL_REQUEST_TEMPLATE/ 디렉토리에 여러 .md 파일을 두면 됩니다.
markdown
## PR 요약
- 이 PR의 주요 변경 사항을 간략하게 기술해 주세요.
## 변경 사유
- 이 변경이 필요한 이유나 배경을 설명해 주세요.
## 체크리스트
- [ ] 코드의 변경 사유와 목적이 명확하게 기술되었나요?
- [ ] 새로운 테스트가 추가되었고, 기존 테스트는 모두 통과하나요?
- [ ] 변경된 코드가 기존 기능에 영향을 주지 않도록 설계되었나요?리뷰어는 이 템플릿 덕분에 PR의 목적과 변경 범위를 훨씬 빠르게 파악할 수 있습니다. 같은 방식으로 .github 디렉토리에는 Issue Template, Funding 설정 같은 것도 추가할 수 있습니다.
출처: Codyssey-B1/B2-2