Github 컨벤션 - Team-HGD/SniffMEET GitHub Wiki
Note
dev브랜치에merge합니다.
- main
- dev
- feature/이슈번호/ <기능이름>
feature/<이슈번호>/<기능이름>
ex)
feature/#12/ib-outlet-action- feat #이슈번호: 커밋 메세지
- merge #PR번호: PR제목
- feat : 새로운 기능 추가
- fix : 버그 수정
- docs : 문서 수정
- style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
- refactor : 코드 리펙토링
- test : 테스트 코드, 리펙토링 테스트 코드 추가
- chore : 빌드 업무 수정, 패키지 매니저 수정
- design: CSS 등 사용자 UI 디자인 변경
- rename: 파일 혹은 폴더명 수정
- remove: 파일을 삭제하는 작업만 수행한 경우
- add: 리소스, 라이브러리 등 추가
위의 기능 태그를 제목의 가장 앞에 배치합니다. 대괄호 안에 소문자로 넣습니다.
[refactor] #2 마스터 컨트롤 프로그램 삭제
[feat] #2 Add something그 다음으로는 해당 커밋의 핵심 내용을 요약한 제목을 작성합니다. (50자 미만)
영어의 경우 대문자로 시작하며, 마침표를 붙이지 않습니다.
또 제목은 명령문이 되어야 합니다.
무엇을 했고 왜 그런지에 대해 설명합니다.
제목과는 개행으로 구분되어야 합니다.
[refactor] 마스터 컨트롤 프로그램 삭제
마스터 컨트롤 프로그램(MCP)이 사악하게 변해서 세계를 통제하려고 함.
이 커밋은 Tron 디스크를 MCP에 (삭제를 위해) 던져 넣어 MCP는 다시 체스
게임으로 돌아감.[refactor] serialize.h 예외 처리를 간략화한다
serialize.h stream 구현과 관련된 메소드에서 'state'와 'exceptmask'를
삭제한다.
exceptmask는 언제나 'failbit'을 포함하고, setstate는 언제나 bits = failbit
과 함께 호출되며 이 모든 것은 즉각적으로 예외를 발생시킨다. 이 변수들을 삭제하고
setstate가 즉각적으로 예외를 발생시키게 바꾼다. (물론 몇몇 죽은 코드도 지운다)
그 결과 good()은 실패 후 절대 도달할 수 없고 (딱 두 군데서 호출되는데 한 곳은
테스트 안임) 이것은 단순히 !eof()로 대체할 수 있다.
fail(), clear(n),exceptions()은 전혀 호출되지 않는다. 해당 요소들은 삭제한다.이슈 네이밍
- [feat] 기능 단위
이슈 템플릿
##📌 Issue<!-- 이슈에 대해 간략하게 설명해주세요 -->
##✅ To-do<!-- 진행할 작업에 대해 적어주세요 -->- [ ] todo!
PR 네이밍
- [feat] 기능 단위
- [feat, fix] 기능 단위
PR 템플릿
PR을 올리기 전에 아래 체크리스트를 모두 만족하는지 점검한다.
모두 만족한다면 체크리스트 내용을 지우고 PR을 올린다.
### 🔖 Issue Number
Close #
### 📙 작업 내역
> 구현 내용 및 작업 했던 내역을 적어주세요.
>
- [ ] 작업 내역 작성
### 📋 체크리스트
- [ ] Merge 하는 브랜치가 올바른가?
- [ ] 코딩컨벤션을 준수하는가?
- [ ] PR과 관련없는 변경사항이 없는가?
- [ ] 내 코드에 대한 자기 검토가 되었는가?
### 📝 PR 특이 사항
> PR을 볼 때 팀원에게 알려야 할 특이사항을 알려주세요.
>
- 특이 사항 1
- 특이 사항 2
### 👻 참고자료(레퍼런스)
- 참고한 자료
- 깃헙 위키 페이지label
이슈, PR 작성 시 PR 담당한 사람 태그 필수
fast-forward 방식으로 머지를 수행한다.
Created. 2024.10.29