-
GITHUB issue/pullRequest Template 생성 및 적용정리 2024. 9. 10. 12:02
협업할 때 issue 생성 -> branch 생성 -> 코드 수정 -> pullRequest 생성 순으로 작업하면 편하다.
issue와 pr은 템플릿을 사용하면 통일감있어 좋다.
-
.github/PULL_REQUEST_TAMPLATE/pull_request_template.md
### PR 타입(하나 이상의 PR 타입을 선택해주세요) - [ ] Feat : 새로운 기능 추가 - [ ] Remove : 파일 및 기능 삭제 - [ ] Test : 테스트 코드 추가 - [ ] Fix : 버그 수정 - [ ] Docs : 문서 수정 - [ ] Refactor : 코드 리펙토링 - [ ] Style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우, 주석 추가 ### 반영 브랜치 ex) feat/login -> dev ### 변경 사항 ex) 로그인 시, 구글 소셜 로그인 기능을 추가했습니다. ### 테스트 결과 ex) 베이스 브랜치에 포함되기 위한 코드는 모두 정상적으로 동작해야 합니다. 결과물에 대한 스크린샷, GIF, 혹은 라이브 데모가 가능하도록 샘플API를 첨부할 수도 있습니다.
작업할 폴더에 다음 md 파일을 생성해준다.
.github 내에 생성하면 알아서 템플릿이 적용된다.
코드 수정 후 브랜치 merge할 때 pr을 생성하면 해당 템플릿이 보인다.
원하는대로 수정 후 pr 올리면 된다.
- 이슈 템플릿은 깃헙에서 바로 만들어도 된다.
General - 하단에 set up templates를 클릭
제공된 버그/피처 템플릿을 사용해도 된다.
Custom template을 누르면 수정 버튼을 눌러 수정할 수 있다.
name부터 하나하나 지정할 수 있다.
### Issue 타입(하나 이상의 Issue 타입을 선택해주세요) - [ ] Feat : 새로운 기능 추가 - [ ] Remove : 파일 및 기능 삭제 - [ ] Test : 테스트 코드 추가 - [ ] Fix : 버그 수정 - [ ] Docs : 문서 수정 - [ ] Refactor : 코드 리펙토링 - [ ] Style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우, 주석 추가 ### 상세 내용 - [ ] ex) Github 소셜 로그인 기능이 필요합니다. ### 추가사항
이는 내가 사용할 issue 템플릿이다.
이제 이슈를 생성하면 아래처럼 템플릿이 뜨고, 이를 수정하여 이슈 제출하면 된다.
'정리' 카테고리의 다른 글
GIT, GITHUB(egoing 강의 참고) (7) 2024.09.08 깃허브 블로그 만들기 - 윈도우 (0) 2024.08.09 우분투 설치 (VirtualBox) (1) 2024.02.27 [교양글쓰기 정리] 인용하는 법 (1) 2023.12.20 Could not resolve host: githib.com (2) 2023.12.05