git commit 메시지 작성 시 description 곁들이기

2023. 7. 2. 17:44· Back-up/Git + Github
목차
  1. +α

요즘 소스트리가 윈도우에서는 켜지지도 않고, 맥에서는 푸시가 안되고...

이래저래 문제가 많은 와중에 굳이 삭제하고 다시 깔기도 귀찮아서 터미널에서 커맨드를 쓰거나 fork 라는 것을 대신해서 쓰고 있다.


fork에서는 description쓰는 ui가 편하게 돼있는데 소스트리에서는 description쓰는 것이 안보여서 커맨드로 description을 추가하려면 어떻게 하나 찾아봤다.

 

 

먼저 앞으로 쭉 이렇게 사용하고싶다면 이걸 실행하자.

 

git config --global core.editor "code --wait"

 

 

 

 

내 로컬의 git 환경설정에서 git commit 명령어를 치면 위와 같이 vscode창을 띄워서 커맨드 메시지와 description을 작성할 수 있는 vscode창이 생긴다.

 

 

위에서 '잘 작성 되겠거니...' 를 추가했으니 신경쓰지 말 것

커밋 메시지를 작성하고서 켜진 창을 끄면 다음과 같은 상태가 뜬다.

이대로 git push 를 진행한 결과는 다음과 같다.

 

아주 잘 됐다.

줄바꿈까지 알아서 바꿔주고 편하다. 

 

 

+α

굳이 description까지 곁들여야하는 것은...

일반적으로 커밋을 생성할 때 설명을 작성하는 것이 좋다고 한다.

왜냐하면 잘 만들어진 커밋 메시지는 변경 사항의 목적과 맥락을 전달하는 데 도움이 되고,

다른 사람이나 미래의 내가 커밋 의도를 더 쉽게 이해할 수 있으니까.

 

 

잘 구성된 git commit 메시지 예시의 경우 다음과 같다.

Add user authentication feature

This commit adds a new feature for user authentication.
It includes the necessary routes, controllers, and UI components
to allow users to register, log in, and log out of the application.

Fixes #123

 

 

참고

 

stackoverflow

 

How to commit a change with both "message" and "description" from the command line?

I can push commits to GitHub via git (on the command line, not the Mac app). When I push commits directly from the GitHub web interface (e.g. quickly fixing a typo), I have the chance to "comm...

stackoverflow.com

 

 

vscode

 

Source Control with Git in Visual Studio Code

Visual Studio Code source control management with integrated Git support.

code.visualstudio.com

 

 

반응형
저작자표시 (새창열림)

'Back-up > Git + Github' 카테고리의 다른 글

pull request 날리고 브랜치 처리  (0) 2023.07.06
git + 정리  (0) 2023.04.04
깃, 깃허브 제대로 배우기  (0) 2023.03.23
git push한 후 리퍼지토리의 이름을 변경했을 때  (0) 2019.09.08
  1. +α
'Back-up/Git + Github' 카테고리의 다른 글
  • pull request 날리고 브랜치 처리
  • git + 정리
  • 깃, 깃허브 제대로 배우기
  • git push한 후 리퍼지토리의 이름을 변경했을 때
sovelop
sovelop
무슨 생각을 해.. 그냥 하는거지
sovelop
so's devlog
sovelop
전체
오늘
어제
  • 분류 전체보기 (141)
    • 🔥TIL (15)
    • 생각 (5)
      • Daily Routine (0)
    • WEB (2)
    • VueJS (1)
    • 파이썬 문법 (17)
      • Django (0)
    • 알고리즘 (23)
      • 백준 알고리즘 (13)
      • 프로그래머스 (0)
      • 기타 사이트 알고리즘 (6)
    • 컴퓨터공학입문 (13)
    • Data_Analysis (9)
    • Javascript (8)
      • 문법 (8)
      • node.js (0)
    • Java (9)
      • 문법 (3)
      • Android Studio (0)
      • Algorithm (2)
    • Server (6)
      • sql (2)
      • linux (2)
    • Back-up (22)
      • Git + Github (5)
      • English (0)
      • etc (17)
    • 테크 관련 세미나 (4)
    • English (0)
    • Error (4)
    • 코테후기 (0)

블로그 메뉴

  • About me

공지사항

인기 글

태그

  • 한빛미디어
  • va87m
  • 혼공자
  • 혼공단
  • 코알라univ
  • 무접점저소음
  • # 백준 #파이썬 #python
  • 코딩좀알려주라

최근 댓글

최근 글

hELLO · Designed By 정상우.v4.2.2
sovelop
git commit 메시지 작성 시 description 곁들이기
상단으로

티스토리툴바

개인정보

  • 티스토리 홈
  • 포럼
  • 로그인

단축키

내 블로그

내 블로그 - 관리자 홈 전환
Q
Q
새 글 쓰기
W
W

블로그 게시글

글 수정 (권한 있는 경우)
E
E
댓글 영역으로 이동
C
C

모든 영역

이 페이지의 URL 복사
S
S
맨 위로 이동
T
T
티스토리 홈 이동
H
H
단축키 안내
Shift + /
⇧ + /

* 단축키는 한글/영문 대소문자로 이용 가능하며, 티스토리 기본 도메인에서만 동작합니다.