스낵깃 🍪 - 협업편 #2: PR 생성 시 리뷰어 자동 지정하는 법 (CODEOWNERS 활용)

🔹 GitHub PR 생성 시 리뷰어 자동 지정하는 법 🚀

---

1️⃣ 매번 리뷰어를 직접 추가하는 것이 번거롭다면?

GitHub에서 PR을 생성할 때 매번 리뷰어를 직접 추가하는 것이 귀찮거나 까먹는다면

CODEOWNERS 기능을 활용하여 리뷰어를 자동으로 배정할 수 있다.

 

“내가 작업한 파일에 대해 자동으로 코드 리뷰어를 지정할 수 있을까?”

“매번 수동으로 리뷰어를 추가하는 과정이 번거로운데, 자동화하는 방법이 있을까?”

 

✅ 그 해답이 바로 GitHub의 CODEOWNERS 기능이다.

 

이 글에서는 CODEOWNERS 파일을 설정하여 PR 생성 시 리뷰어를 자동으로 추가하는 방법을 정리한다.

---

2️⃣ CODEOWNERS란?

 

GitHub의 CODEOWNERS 파일은 특정 디렉토리나 파일에 대해

PR이 생성될 때 자동으로 리뷰어를 배정하는 기능을 제공한다.

 

즉, “이 파일이 변경되면 자동으로 이 사람에게 리뷰 요청을 보낸다!” 라고 설정하는 것이다.

 

✅ 예를 들어 이런 상황에서 유용하다.

• backend/ 디렉토리에서 변경이 발생하면 백엔드 팀이 자동으로 리뷰 요청을 받음

• frontend/ 디렉토리는 프론트엔드 팀에게 리뷰 요청이 가도록 설정

• config/ 파일이 변경되면 DevOps 담당자에게 자동 할당

• README.md 파일이 수정되면 문서 담당자에게 자동 리뷰 요청

 

즉, 팀 협업을 진행할 때 특정 파일이나 디렉토리에 대한 코드 리뷰 담당자를 미리 지정할 수 있는 기능이다.

 

이제 실제로 어떻게 설정하는지 알아보자.

 

---

3️⃣ CODEOWNERS 설정 방법

(1) CODEOWNERS 파일 생성하기

CODEOWNERS 파일은 프로젝트의 .github/ 디렉토리에 위치해야 한다.

mkdir -p .github
touch .github/CODEOWNERS

✅ 기존에 .github 폴더가 있다면 생략하고 파일만 추가하면 된다.

---

(2) CODEOWNERS 파일 작성하기

이제 CODEOWNERS 파일을 열어, 자동 리뷰어 지정 규칙을 추가한다.

# 특정 파일 또는 디렉토리에 대한 자동 리뷰어 지정

# 백엔드 코드 리뷰어 자동 지정
/backend/ @backend-team

# 프론트엔드 코드 리뷰어 자동 지정
/frontend/ @frontend-team

# DevOps 담당자 자동 지정
/config/ @devops-team

# 특정 파일 담당자 지정
README.md @docs-team

📌 설정 규칙 정리

✅ backend/ 디렉토리가 수정되면 @backend-team이 자동 리뷰어로 추가됨

✅ config/ 폴더에서 변경이 발생하면 @devops-team이 리뷰어로 추가됨

✅ README.md 파일이 수정되면 @docs-team이 리뷰어로 자동 지정됨

 

💡 특정 팀이 아니라 개인 사용자도 지정할 수 있다.

/backend/ @backend-team @itstimi-XD

✅ 백엔드 팀 전체 + itstimi-XD 사용자에게 리뷰 요청

 

📌 팀(@backend-team)과 개인(@username) 모두 지정 가능하다.

---

(3) CODEOWNERS 파일 커밋하고 적용하기

파일을 저장한 후, Git에 반영한다.

git add .github/CODEOWNERS
git commit -m "Add CODEOWNERS for auto reviewer assignment"
git push origin main

✅ 이제 GitHub에서 PR을 생성하면, 자동으로 리뷰어가 배정된다! 🎉

---

4️⃣ 실제로 어떻게 동작할까?

이제 PR을 생성해보면, 오른쪽 Reviewers 섹션에 자동으로 리뷰어가 추가된다.

 

🛠 자동 리뷰어 지정 예시

 

✅ 백엔드 코드 수정 → @backend-team이 자동 리뷰어로 추가됨

✅ config/ 디렉토리 수정 → @devops-team이 자동 리뷰어로 추가됨

✅ README.md 수정 → @docs-team이 리뷰어로 자동 지정됨

 

💡 이제 리뷰어를 일일이 추가할 필요 없이 GitHub가 알아서 해준다!

---

5️⃣ CODEOWNERS 파일을 활용할 때 주의할 점

🚨 CODEOWNERS가 정상적으로 적용되지 않는다면?

CODEOWNERS 파일이 적용되지 않는 경우, 아래 사항을 확인해보자.

 

✅ 파일 위치가 .github/CODEOWNERS에 정확하게 저장되었는가?

✅ 지정한 리뷰어(@username 또는 @team)가 해당 프로젝트의 Collaborator 또는 Team으로 등록되어 있는가?

✅ 파일 형식이 올바르게 작성되었는가? (탭이 아닌 공백으로 구분, 특수문자 없이 작성)

 

📌 GitHub의 권한 정책에 따라 CODEOWNERS 기능이 일부 제한될 수도 있으니, 설정 후 테스트해보는 것이 중요하다.

---

6️⃣ CODEOWNERS를 활용한 코드 리뷰 자동화

이제 CODEOWNERS 파일을 활용하여 PR 리뷰어 자동 배정을 설정할 수 있다.

그렇다면, 코드 리뷰를 요청할 때는 어떻게 하면 좋을까? 🤔

 

✅ PR 작성 시 리뷰어에게 집중적으로 확인할 부분을 요청하는 것이 중요하다.

✅ 관련 내용은 “GitHub에서 리뷰어 요청하는 법과 효과적인 코드 리뷰 요청 가이드” (협업편 #1)에서 자세히 다루고 있다.

 

📌 PR 자동 리뷰어 지정 + 효과적인 리뷰 요청을 함께 적용하면 코드 리뷰 프로세스를 더욱 원활하게 만들 수 있다! 🚀

---

📌 결론

✅ CODEOWNERS 파일을 활용하면 PR 생성 시 자동으로 리뷰어가 배정될 수 있다.

✅ 특정 파일이나 디렉토리에 대해 담당자를 미리 설정하여, 협업을 더욱 원활하게 할 수 있다.

✅ GitHub의 협업 기능을 적극 활용하면 코드 리뷰 프로세스를 효율적으로 관리할 수 있다!

 

🔥 자동화된 리뷰어 지정으로 GitHub 협업을 더욱 스마트하게 사용해보자! 🚀