📒 오늘 공부한 내용

🔍목차

[1-1] git 협업순서
[1-2] 기본적인 branch 명령어 총정리
[1-3] git 커밋 컨벤션

✅ git 협업순서

1️⃣ 라퍼지토리 생성하기

• New repository 를 클릭하면 Repository 생성 화면으로 넘어가게 된다.
• Repository 생성 화면으로 오시면 Repository 이름과 설명, Repository 공개 유무와 같은 초기 설정을 하시고 하단의 Create repository 버튼을 누르시면 생성이 완료된다.
• Code 버튼을 눌러서 Repository를 clone 하시면 로컬 환경에서 개발을 시작하실 수 있다.

2️⃣ 공동 작업자(팀원) 초대

• 우선 메뉴의 Settings로 들어간다.
• Collaborator를 초대하기 위해 Manage access 탭으로 이동한 뒤 Invite a collaborator 버튼을 눌러 원하는 유저(팀원)를 초대하면 된다.

3️⃣ Projects 기능을 이용한 칸반 보드 설정

• Github 메뉴 중 Projects로 이동

• 상단의 Create a project 를 누르시면 칸반 보드를 생성하는 화면으로 이동하게 된다. 각 입력칸을 채워주면된다.

  

  

4️⃣ Git-flow 전략

master : 제품으로 출시될 수 있는 브랜치
develop : 다음 출시 버전을 개발하는 브랜치
feature : 기능을 개발하는 브랜치
release : 이번 출시 버전을 준비하는 브랜치
hotfix : 출시 버전에서 발생한 버그를 수정 하는 브랜치

💡 git-flow라고 불리며, 다음과 같은 단계로 이루어진다

1. 처음에는 master와 develop 브랜치가 존재한다. develop 브랜치는 master에서부터 시작된 브랜치이다.
2. develop 브랜치에서는 상시로 버그를 수정한 커밋들이 추가된다.
3. 새로운 기능 추가 작업이 있는 경우 develop 브랜치에서 feature 브랜치를 생성한다. feature 브랜치는 언제나 develop 브랜치에서부터 시작하게 된다.
4. 기능 추가 작업이 완료되었다면 feature 브랜치는 develop 브랜치로 merge 된다.
5. develop에 이번 버전에 포함되는 모든 기능이 merge 되었다면 QA를 위해 develop 브랜치에서부터 release 브랜치를 생성한다.
6. QA를 진행하면서 발생한 버그들은 release 브랜치에 수정된다.
7. QA를 무사히 통과했다면 release 브랜치를 master와 develop 브랜치로 merge 한다.
8. 마지막으로 출시된 master 브랜치에서 버전 태그를 추가한다.

✅ 기본적인 branch 명령어 총정리

• branch 생성 및 생성된 branch로 전환

  git checkout -b <branch 이름>

• 현재 자신의 파일과 연결된 branch 목록

  git branch

• branch전환

  git checkout <branch 이름>

• branch 생성

  git branch <branch 이름>

• branch 삭제

  git branch -d <branch 이름>

• branch 강제 삭제

  git branch -D <branch 이름>

• branch에 코드push

  git push origin <branch 이름>

• merge하는 법

  git checkout <branch 이름>
  git merge <branch 이름>

  • 예제 1) master에다가 A라는 branch를 merge하고 싶으면,

    git checkout master
    git merge A

  • 예제2) B라는 branch에다가 C라는 branch를 merge하고 싶다면,

    git checkout B
    git merge A

• branch 끼리 비교

  git diff <branch 이름> <branch 이름

  • 예제1) master과 A라는 branch를 비교하고 싶다면

    git diff master A

💡 깃 내려받고 풀리퀘스트하는 순서

시작 시

1️⃣ 현재 로컬 저장소에 다른 리모트 저장소를 추가하는 명령어

git remote add upstream https://github.com/code-bootcamp/holidays_client.git 
← 주소는 회사 레파지토리의 code부분을 복붙하면 된다.

작업 시

1️⃣ feature 브런치 생성

git checkout -b feature-issue5  
← 여기서 issue5는 나의 issue 순서를 작성하면 된다.(feature-issue5부분이 매일 바뀐다.)

2️⃣ 현재 브런치 확인

git branch

작업종료 시

1️⃣ 현재 작업 디렉토리의 모든 변경 사항을 git의 staging area에 추가

git add .

2️⃣ 커밋 컨벤션 적용

git commit -m “커밋 내용” 
← ‘커밋 컨벤션’ 적용해서 하기: 팀원들끼리 정하기 (커밋 내용 잘 작성해서 커밋하는게 좋음

3️⃣ origin으로 푸쉬

git push origin feature-issue5 
← (origin으로 푸쉬해야 한다, 아까 만든 feature-issue5브랜치를 작성해야 한다.)

4️⃣ 깃허브: fork했던 내 레파지토리로 들어가서 풀리퀘스트 요청하기

다시 작업시작 시

1️⃣ 내려받을 브런치 확인

git checkout master (마스터로 되어있는지 꼭 확인)

2️⃣ 내려 받기

git pull upstream develop 
← 이렇게 pull을 하면 끝! (develop인지 developer인지 확인하려면 git branch -a로 확인하기)

✅ git 커밋 컨벤션

*️⃣ Commit Type

feat : 새로운 기능 추가
fix : 버그 수정
docs : 문서 수정
style : 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
refactor : 코드 리펙토링
test : 테스트 코드, 리펙토링 테스트 코드 추가
chore : 빌드 업무 수정, 패키지 매니저 수정

*️⃣ Subject Rule

1. 제목은 최대 50글자 넘지 않기
2. 마침표 및 특수기호 사용x
3. 첫 글자 대문자, 명령문 사용
4. 개조식 구문으로 작성(간결하고 요점적인 서술)

*️⃣ 커밋 템플릿

# 제목은 최대 50글자까지 아래에 작성: ex) Feat: Add Key mapping

# 본문은 아래에 작성

# 꼬릿말은 아래에 작성: ex) Github issue #23

# --- COMMIT END ---
#   <타입> 리스트
#   feat        : 기능 (새로운 기능)
#   fix         : 버그 (버그 수정)
#   refactor    : 리팩토링
#   design      : CSS 등 사용자 UI 디자인 변경
#   comment     : 필요한 주석 추가 및 변경
#   style       : 스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음)
#   docs        : 문서 수정 (문서 추가, 수정, 삭제, README)
#   test        : 테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음)
#   chore       : 기타 변경사항 (빌드 스크립트 수정, assets, 패키지 매니저 등)
#   init        : 초기 생성
#   rename      : 파일 혹은 폴더명을 수정하거나 옮기는 작업만 한 경우
#   remove      : 파일을 삭제하는 작업만 수행한 경우
# ------------------
#   제목 첫 글자를 대문자로
#   제목은 명령문으로
#   제목 끝에 마침표(.) 금지
#   제목과 본문을 한 줄 띄워 분리하기
#   본문은 "어떻게" 보다 "무엇을", "왜"를 설명한다.
#   본문에 여러줄의 메시지를 작성할 땐 "-"로 구분
# ------------------
#   <꼬리말>
#   필수가 아닌 optioanl
#   Fixes        :이슈 수정중 (아직 해결되지 않은 경우)
#   Resolves     : 이슈 해결했을 때 사용
#   Ref          : 참고할 이슈가 있을 때 사용
#   Related to   : 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)
#   ex) Fixes: #47 Related to: #32, #21

*️⃣ 커밋 예시

$ git commit

위 템플릿에 공백 3줄이 우리가 채워넣을 line이다.

signin, signup 기능이 추가되었다고 가정해보자.

커밋 메시지는 아래와 같을 것이다.

Feat: Add signin, signup

회원가입 기능, 로그인 기능 추가(예시를 위해 간단히 작성)

Resolves: #1

템플릿에는

첫번째 줄엔 Feat: Add signin, signup

두번째 줄엔 signup과 signin을 어디에 추가했고, 왜 추가했는지에 대한 글을 남긴다.(생략 가능)

세번째 줄엔 issue에 대한 부분은 없지만 이슈1을 해결했다고 가정하자(생략 가능)

wq로 저장하고 나가면 커밋이 자동으로 된다.(vim editor임)

이런식으로 커밋을 하게 되면, 약속대로 signin, signup기능이 추가되었음을 메시지를 통해 직관적으로 알 수 있게 된다.

*️⃣ 템플릿은 어떻게 적용을 시키는가?

1. 본인이 원하는 경로에 gitmessage.txt 파일을 생성한다.

2. 내용은 위 템플릿 내용을 넣는다.(#은 주석임)

3. 터미널에 명령을 입력한다.

$ git config --global commit.template C:\.gitmessage.txt (예시를 위해 C:\ 경로를 주었고 실제로는 본인 경로에다가!)

이 설정을 통해 앞으로 $ git commit 명령어를 통해 앞전에 만들었던 vim의 메시지가 보일 것이다.

📩 참고 자료

우아한 기술블로그
코드짜는 문과녀