본문 바로가기

카테고리 없음

Github Issue 생성하기

프론트에서 여러 페이지에 재사용될 NavBar 컴포넌트 구현 작업을 하나의 이슈로 만들어

작업 완료 후 이슈 close까지 해보려고 한다.

 

우선, Github에 수행하고자 하는 특정 작업에 대한 Issue를 생성한다.

프로젝트 탭의 Issues 탭 > 오른쪽 상단의 New issue 버튼을 클릭하여 내용 작성 후 > Submit new issue 버튼을 클릭하면 이슈를 생성할 수 있다.

 

 

나는 "NavBar 구현" 이라는 이름의 Issue를 생성했고, 이슈 번호는 #10 이었다.

 

 

(여기서부터는 내 로컷 git에서 하는 작업)

내가 작업하고있는 vsCode의 Terminal에서 

  git checkout -b feature-navbar   

명령어로 새로운 브랜치를 만들어 해당 브랜치로 이동했다.

 

NavBar 컴포넌트 구현을 마친 후, 

  git add .

  git commit -m "[FEAT] Navbar 컴포넌트 구현 #10"  

  git push origin feature-navbar  

커밋 메시지에 #{issue_number}를 포함해 내 원격 github에 push하였다.

커밋 메시지에 #{issue_number}를 넣는 이유는, 그 커밋이 main 브랜치에 병합될 때 자동으로 관련 이슈를 닫을 수 있기 때문이다.

이는 프로젝트 관리를 자동화하고, 작업 완료 상태를 명확하게 표시하는 데 도움이 된다.

 

 

(다시 Github로 돌아가 수행하는 작업들)

이제 Github로 돌아가서 Pull requests > New pull request를 클릭한다.

새로운 branch를 생성해 로컬 깃에서 code를 push했던 feature-navbar의 pull request 요청이 와있는 것을 확인할 수 있다.

 

 

feature-navbar를 클릭한 후, base를 병합하고자 하는 branch(main)으로 설정한 후, Create pull request 버튼을 클릭해 pull request 요청을 생성한다.

 

 

 

생성된 pull request 요청에 대해 Merge pull request 버튼을 눌러 해당 리퀘스트를 main브랜치에 병합한다.

 

 

PR의 제목과 설명을 입력할 때, 설명에 "#이슈번호"를 포함시키면 PR이 병합될 때 관련 이슈가 자동으로 닫히게 된다.

pull request가 성공적으로 수행되었고, NavBar 구현에 대한 issue #10도 닫혀서 해당 작업에 대한 완료 기록을 남겼다.

작업 완료 후 다른 브랜치로 merge된 branch에 대해서는 'Delete branch'를 눌러 해당 브랜치를 삭제할 수 있다.

 

main branch에 가서 확인해 보았더니 feature-navbar에 대한 merge가 정상적으로 이루어졌음을 확인할 수 있었다.