[Github] PR 올릴 때 유용한 두 가지 파일(CODEOWNERS, pull_request_template.md)

회사에서 동기들과 미니 프로젝트를 하면서 깃을 사용하고 있다. 깃허브에서 PR을 올려서 코드 리뷰를 받는데, 이때 유용하게 사용할 수 있는 두 가지 파일을 소개하려고 한다 ㅎㅎ

CODEOWNERS

이 파일을 사용해서 레포지토리의 코드를 담당하는 사람들을 지정할 수 있다. (이 사람들은 레포지토리에 읽기 권한이 있어야 한다)
PR 요청을 열면, 이 파일에서 지정한 사람들이 자동으로 리뷰어로 등록된다!

루트 디렉토리에 둬도 되고, .docs/, .github/ 폴더 안에 둬도 된다.

* @example1 @example2 @example3
*.js @example4

이런 식으로 사용한다.
* 뒤에 쓴 유저들은 이 레포지토리의 모든 파일에 대해서, PR이 왔을 때 리뷰어가 된다.

*.js 뒤에 쓴 유저들은 JS 파일에 대한 PR이 왔을 때만 리뷰어가 된다.

이 규칙들은 아래 링크에 상세히 나와있다.

동기님들, 선배님들... 10명 정도를 매번 리뷰어로 등록하기 번거로웠는데, 이 파일을 쓰니 편했다 ! ㅎㅎ

관련된 깃허브 문서 링크이다~~

pull_request_template.md

이 파일을 사용해서 PR 템플릿을 정할 수 있다.
PR 요청을 작성하려고 하면, 그 본문에 자동으로 이 템플릿 내용이 나온다.

루트 디렉토리에 둬도 되고, .docs/, .github/ 폴더 안에 둬도 된다.

pull_request_template.md 파일을 만들고, 안에 내용을 입력하면 된다.

PR 템플릿에 들어갈 내용은 팀, 사람마다 다르게 정할 수 있을 것 같다. 그래도 대략 이런 내용이 들어가는 것 같다.

1. 어떤 작업을 했는지 설명(지라를 쓰면 그 이슈 번호도)
2. 캡쳐 사진이나 GIF
3. 테스트 내용
4. 고민한 내용

여러 템플릿을 만들고, 쿼리 매개변수를 이용해서 그 내용을 바꿀 수도 있다고 한다.!! (아래 문서를 참고)

관련된 깃허브 문서 링크이다 !

 

---

추신) 코드 리뷰 이야기가 나와서..ㅎㅎ 우아한 테크 세미나- 코드 리뷰를 봤는데 도움이 많이 되었다 ㅎㅎ