코딩,해볼까

05.09. [술술술_project. 2] pull request / commit message / code convention 본문

Back/TIL

05.09. [술술술_project. 2] pull request / commit message / code convention

떠굥 2023. 5. 9. 13:34

0.  오늘 배운 것

1) pull request : 원작자 권한일 때 pull request가 어떻게 이루어지는지 

2) 각종 컨벤션 적용

3) 커밋 정렬, 제목, 내용 작성 및 issues 추가


1.  문제점

pull request 시 정렬이 각자 다르면 공백이 전부 표시되어서 불편하다. 


2. 시행착오

 

✨오늘의 pull request 기록

 

# 현재까지의 commit 기록
git log

# 모든 브랜치의 commit 기록
get log --branches

 

# 변경사항을 비교

git diff

 

#  로컬 저장소에서 하는 Synk fork.
#  fetch develop 후 checkout origin/develop과 내용이 일치하는지 확인하면 된다.

#  origin/develop : 원격저장소(github)의 develop

git fetch 

 

# git pull  =  git fetch + git merge

pull보다는  fetch

 

 

# 워킹 디렉토리에서 수정한 파일들만 저장

git stash 

 

# 위 저장된 내용을 원하는 브랜치에서 꺼내준다. number가 0이면 가장 최신의 내용.

git stash apply @{number} 

 

 

 


3. 해결방법

pep8에 따른 코드컨벤션 맞추기

 

 

 


4. 알게된 점

 

✨ 각종 컨벤션 

 

1. commit message convention

 

기본 커밋 메시지 컨벤션

#<타입>: <제목> 의 형식으로 제목을 아래 공백줄에 작성
#제목은 50자 이내 / 변경사항이 "무엇인지 명확히 작성/ 끝에 마침표 금지 # 예) :sparkles:Feat: 로그인 기능 추가,
# 바로 아래 공백은 지우지 마세요 (제목과 본문의 분리를 위함)
#본문(구체적인 내용)을 아랫줄에 작성
#여러 줄의 메시지를 작성할 땐 "-"로 구분 (한 줄은 72자 이내)
#꼬릿말(footer)을 아랫줄에 작성 (현재 커밋과 관련된 이슈 번호 추가 등) #예) Close #7, related_to: #7

git commit > i 누르면 작성 시작 > 작성 > esc > :wq

 

 

깃모지 추가 :  :[스파클 이모티콘]:단어: 내용

https://inpa.tistory.com/entry/GIT-⚡️-Gitmoji-사용법-Gitmoji-cli

# :sparkles:Feat: 새로운 기능 추가
# :bug:Fix: 버그 수정
# :ambulance:!HOTFIX: 급한 오류 수정
# :books: Docs: 문서 수정
# :umbrella:Test: 테스트 코드 추가
# :hammer:Refact: 코드 리팩토링
# :art:Style: 코드 의미에 영향을 주지 않는 변경사항
# :lipstick:Design: CSS 등 사용자 UI디자인 변경
# :Comment: 필요한 주석 추가 및 변경
# :Rename: 파일 혹은 폴더명을 수정하거나 옮기는 작업만의 경우
# :Remove: 파일을 삭제하는 작업만 수행한 경우
# Chore: 빌드 부분 혹은 패키지 매니저 수정사항

 

PR후 다른 브랜치 생성해서 작업하는 경우

fork한 내 repo Synk fork -> git fetch -> git checkout origin/develop로 fetch상태 확인
git checkout develop-> git merge origin/develop으로 머지 -> 기존 branch -D 삭제
-> develop에서 feature/기능으로 gitlog 반영한 branch생성 -> 작업 시작

 

원본 develop에 바뀐 코드가 필요한 경우 & rejected 발생 시

기존 작업 중인 내용 git stash로 저장 -> fork한 내 repo Synk fork -> 
git fetch -> git checkout origin/develop로 fetch상태 확인
git checkout develop-> git merge origin/develop으로 머지 -> 기존 branch -D 삭제
-> develop에서 feature/기능으로 git log 반영한 branch생성 -> 
git stash apply stash@{0}로 stash 적용
-> conflict발생시 해결 -> 작업 시작

 

2. branch convention

https://ux.stories.pe.kr/183

 

3. serializers : 겹칠 수 있으니 미리 지정해두거나 만든 후 메모

  • users
    • UserSerializer : 유저 회원가입
  • articles
    • ArticleCreateSerializer : 게시글 작성 + 상세 게시글 수정
    • ArticleDetailSerializer : 상세 게시글 보기

 

✨ 티스토리 ERROR 400 해결방법

설정 > 개인 정보 보호 및 보안 > 쿠키 및 기타 사이드 데이터 > 모든 사이트 데이터 및 권한 보기 

> tistory.com 검색 후 휴지통 클릭

 

Comments