2023-12-27, Today I Learned

오늘 한 일

팀원들과 함께 코드 컨벤션/ 커밋 컨벤션/ 브랜치 컨벤션을 정했다!

 

커밋 컨벤션

"태그: 제목"
Feat 새로운 기능을 추가할 경우
Fix 버그를 고친 경우
Refactor 프로덕션 코드 리팩토링
Comment 필요한 주석 추가 및 변경
Chore 빌드 테스트 업데이트, 패키지 매니저를 설정하는 경우(프로덕션 코드 변경 X)
Rename 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
Remove 파일을 삭제하는 작업만 수행한 경우

!BREAKING CHANGE 커다란 API 변경의 경우
!HOTFIX 급하게 치명적인 버그를 고쳐야하는 경우

Style 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
DesignCSS 등 사용자 UI 디자인 변경

Docs 문서를 수정한 경우
Test 테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 X)

 

 

 

그리고 여러가지 깃허브의 편리한 기능들을 익혔다!

⭐Issue와 PR 연결하기

[#3]Feat : Blah →깃허브에서 보면 #3이 Issue#3으로 자동으로 연결되는 링크가 됨

PR 내용에다가 close#3 쓰면 Issue가 닫힘

Issue 자동 닫기 Keywords

close
closes
closed
fix
fixes
fixed
resolve
resolves
resolved

 

⭐Issue와 Projects 연결하기

Githib의 Issue와 Projects(칸반보드)를 이용하기로 함

1. 레파지토리에서 Issue를 생성한다
2. Issue에 Projects를 연결, Lable 지정, Assignee 지정

 

⭐Issue Template을 markdown으로 지정할 수 있음

1. 깃허브 프로젝트의 Settings → General → Features → Issues → Set up templates → Features → Issues→ Set up templates

 

⭐PR Template 지정하기

Settings → setup template → pull request template 도 md로 작성 가능!!!

Creating a pull request template for your repository - GitHub Docs