Pygame으로 게임 만들기 - 번외. pr템플릿 제작
Pygame으로 게임 만들기 - 번외. pr템플릿 제작
✨pr 템플릿을 만들어보자✨
협업을 하면서 issue작성과 pr작성, 커밋메세지 작성에 대한 중요성을 느꼈는데, 어느정도 통일 되어야할 필요가 있다는 것을 느꼈다. 모두가 각자의 방식대로 작성하다보니 눈에 잘 들어오지 않았기 때문이다. 이를 위해서 템플릿을 제작하였다.
🙋♀️ 템플릿?
형식을 정해두는 것이다. pr이나 이슈를 작성할 때 어떤 형식으로 작성해야 하는지 미리 짜두면 보기에도 깔끔하고, 필요한 정보를 빼놓지 않고 작성할 수 있다는 장점이 있다.
issue템플릿은 레포지토리의 설정에서 무언가를 바꿔야 했는데, 내가 관리자가 아니라서 실패했다ㅜㅜ pr템플릿만 적용시키기로 했다.
아래 블로그를 많이 참고하였다.
1. 형식 만들기
우선 이름이 pull_request_template.md 인 문서를 만든 후 마크다운 문법으로 작성한다.
2. 저장하기
어떤 폴더에 저장할지 정해야 하는데, 문서 파일과 숨김 파일 두가지가 있다. 나는 깔끔한 레포지토리를 위해서 숨김처리 하였다.
.github 폴더를 만든 뒤 넣어주면 된다. 이미 폴더가 존재한다면 새로 만들 필요는 없다.
3. 레포지토리에 적용하기
push등을 이용하여 원본 레포지토리에 적용한다. 이후 pr을 작성할 때마다 내가 작성한 형식이 뜨는 것을 확인할 수 있다!
This post is licensed under CC BY 4.0 by the author.