<div id="readability-page-1" class="page"><div>
<article>

<header>




</header>

<p>Git에서 커밋을 작성할 때는 <code>-m</code> 옵션을 사용해서 커밋 메시지를 지정하는 게 일반적입니다. 하지만 아래와 같은 경우에는 에디터를 사용해서 커밋 메시지를 작성하거나 수정하는 게 편리합니다.</p>
<ul>
<li>여러 줄로 커밋 메시지를 작성하는 경우</li>
<li>본인이 주로 사용하는 에디터로 커밋 메시지를 작성하고 싶은 경우</li>
<li>Rebase 작업으로 커밋 메시지를 수정하는 경우</li>
</ul>
<p>이 글에서는 Git 커밋 메시지를 에디터로 작성하는 방법을 소개합니다.</p>
<nav>
<ul>
<li><a href="#git-%EC%BB%A4%EB%B0%8B%EC%9D%84-%EC%83%9D%EC%84%B1%ED%95%A0-%EB%95%8C-%EC%97%90%EB%94%94%ED%84%B0%EB%A1%9C-%EC%BB%A4%EB%B0%8B-%EB%A9%94%EC%8B%9C%EC%A7%80-%EC%9E%91%EC%84%B1%ED%95%98%EB%8A%94-%EB%B0%A9%EB%B2%95">Git 커밋을 생성할 때 에디터로 커밋 메시지 작성하는 방법</a></li>
<li><a href="#visual-studio-code%EB%A1%9C-%EC%BB%A4%EB%B0%8B-%EB%A9%94%EC%8B%9C%EC%A7%80-%EC%9E%91%EC%84%B1%ED%95%98%EB%8A%94-%EB%B0%A9%EB%B2%95">Visual Studio Code로 커밋 메시지 작성하는 방법</a></li>
<li><a href="#editor%ED%99%98%EA%B2%BD-%EB%B3%80%EC%88%98%EB%A5%BC-%EC%85%B8-%EC%84%A4%EC%A0%95-%ED%8C%8C%EC%9D%BC%EC%97%90-%EC%B6%94%EA%B0%80%ED%95%98%EA%B8%B0">EDITOR환경 변수를 셸 설정 파일에 추가하기</a></li>
</ul>
</nav>
<h2 id="git-커밋을-생성할-때-에디터로-커밋-메시지-작성하는-방법">Git 커밋을 생성할 때 에디터로 커밋 메시지 작성하는 방법</h2>
<p>Git에서는 커밋을 만들 때 필수적으로 커밋 메시지를 작성해야합니다. 일반적으로 커맨드라인에서 커밋 메시지를 작성할 때는 <code>-m</code> 옵션을 사용합니다. 예를 들어 아래와 같이 실행합니다.</p>
<ul>
<li><a href="https://www.lainyzine.com/ko/article/git-commit-command-creating-git-commit/">git commit 사용법: Git 커밋 생성의 모든 것</a></li>
</ul>
<pre><code>$ git commit -m 'Add some new files'</code></pre>
<div>
<p>
Git 스테이징 영역과 커밋
</p>
<div>

<p>이 글에서는 다루지 않지만 Git 커밋을 만들기 위해서는 <code>git add</code> 명령어로 먼저 스테이징 영역에 파일을 추가해야합니다. 예를 들어 <code>index.html</code> 파일을 새로 만들고 이 내용을 커밋으로 만들려면 아래와 같이 명령어들을 실행해야합니다.</p>
<pre><code>$ touch index.html
$ git add index.html
$ git commit -m'Add index.html'</code></pre>
<p>스테이징 영역에 대한 자세한 해설은 아래 글들을 참고해주세요.</p>
<ul>
<li><a href="https://www.lainyzine.com/ko/article/git-add-adding-files-to-git-staging/">git add 사용법: 스테이지 영역에 파일 추가하는 방법</a></li>
<li><a href="https://www.lainyzine.com/ko/article/git-status-show-the-working-tree-status/">git status 사용법: HEAD와 워킹 트리 비교하기</a></li>
</ul>

</div>
</div>
<p>커밋 메시지를 짧게 남길 때는 <code>-m</code> 옵션이 편리합니다만, 긴 커밋 메시지를 남기기는 불편합니다.</p>
<p><code>git commit</code> 명령어는 <code>-m</code> 옵션을 지정하지 않고 실행하면, 커밋 메시지 편집을 위한 에디터를 실행해줍니다. 이 때 <code>$EDITOR</code> 환경변수에 지정된 에디터가 실행됩니다. 이 변수가 비어있다면 아래와 같은 에러가 출력됩니다.</p>
<pre><code>$ git commit
hint: Waiting for your editor to close the file... error: cannot run : No such file or directory
error: unable to start editor ''
Please supply the message using either -m or -F option.</code></pre>
<p>현재 <code>EDITOR</code> 환경변수 값은 아래 명령어로 확인해볼 수 있습니다.</p>
<pre><code>$ echo $EDITOR</code></pre>
<p>아무런 내용이 출력되지 않는다면 <code>$EDITOR</code> 환경변수가 비어있는 상태입니다. 명령어를 실행할 때 적용되는 환경변수를 임시로 셋업할 수도 있습니다. 예를 들어, 아래와 같이 <code>git commit</code> 앞에 변수 키밸류 값을 지정해주면 됩니다. 아래와 같이 실행하면 <code>git commit</code> 수정을 위해 GUN Nano 에디터가 실행됩니다.</p>
<pre><code>$ EDITOR="nano" git commit</code></pre>
<figure>
<img src="https://www.lainyzine.com/ko/article/how-to-write-a-git-commit-message-in-the-editor/assets/EB0DD323-987F-464B-8606-D02EBE9786E3.png" alt="Git 커멧 메시지 편집을 위해 실행된 Nano 에디터">
</figure>
<p>커밋 메시지를 작성하고 컨트롤 + X, Y, Enter를 차례대로 입력해서 커밋 메시지를 저장할 수 있습니다.</p>
<h2 id="visual-studio-code로-커밋-메시지-작성하는-방법">Visual Studio Code로 커밋 메시지 작성하는 방법</h2>
<p>일반적으로 커맨드라인 환경에서는 Emacs, Vim, Nano 등의 에디터를 주로 사용합니다만, 윈도우나 맥에서는 GUI 에디터를 사용하는 것도 가능합니다. 아래와 같이 <code>code -w</code>를 <code>EDITOR</code> 환경변수로 지정하면 깃 커밋 메시지를 편집하기 위한 VS Code가 실행됩니다.</p>
<ul>
<li>관련 글: <a href="https://www.lainyzine.com/ko/article/how-to-execute-visual-studio-code-from-terminal/">터미널에서 Visual Studio Code 실행하는 방법</a>
</li>
</ul>
<pre><code>$ EDITOR='code -w' git commit
hint: Waiting for your editor to close the file...</code></pre>
<p>메시지에 확인할 수 있듯이 에디터가 종료될 때까지 커맨드라인은 대기 상태가 됩니다.</p>
<div>
<p>
VS Code를 대기 모드로 실행하기
</p>
<div>

<p>위 예제에서 <code>code</code>를 실행할 때 <code>-w</code> 옵션을 사용했습니다. <code>-w</code> 옵션을 사용해야 커밋 메시지 작성을 기다리는 대기 상태가 됩니다. <code>-w</code> 옵션을 붙이지 않으면 <code>git commit</code> 메시지를 실행하자마자 커밋 메시지가 없다고 에러가 출력되고 나서 에디터가 실행되어버립니다.</p>
<pre><code>$ EDITOR=code git commit
Aborting commit due to empty commit message</code></pre>
<p><code>git commit</code>에서 Code를 사용할 경우에는 반드시 <code>-w</code> 옵션을 사용해주세요.

</p></div>
</div>
<figure>
<img src="https://www.lainyzine.com/ko/article/how-to-write-a-git-commit-message-in-the-editor/assets/E29F67B7-ED38-4FA5-AA57-17413E31764A.png" alt="Git 커밋 메시지를 입력하기 위해 실행된 VS Code 창">
</figure>
<p><code>Add some new files</code>과 같이 한 줄로 커밋 메시지를 작성할 수도 있습니다만, 아래와 같이 상세한 커밋 메시지를 작성할 수도 있습니다.</p>
<pre><code>Add index.html and style.css for new homepage

* Implement basic HTML structure in index.html, including header, main content, and footer sections
* Add initial CSS styles in style.css for layout, typography, and color scheme
* Integrate responsive design to ensure proper display on various screen sizes
* Prepare for further content and design enhancements in upcoming commits</code></pre>
<p>일반적으로 한 줄 요약을 첫 줄에 적고 두 번째 줄부터는 상세 내용을 작성합니다. 커밋 메시지는 사실상 길이 제한이 없으니 협업을 위해 충분히 자세히 작성하는 것이 좋습니다. 에디터 내용을 저장하고 종료하면 커밋이 생성됩니다.</p>
<h2 id="editor환경-변수를-셸-설정-파일에-추가하기">EDITOR환경 변수를 셸 설정 파일에 추가하기</h2>
<p>이 에디터 설정을 계속 적용하려면 Bash 셸을 사용하는 경우, <code>.bashrc</code>, Zsh 셸을 사용하는 경우 <code>.zshrc</code> 등 자신이 사용하는 셸 설정 파일에 다음 내용을 추가해주어야합니다.</p>
<pre><code>export EDITOR="code -v"</code></pre>

</article>
</div></div>

LZ: 프로그래머 가이드

LainyZine

Git에서 커밋을 만들 때는 커밋 메시지를 작성해야합니다. 커밋 메시지는 커맨드라인에서 직접 남길 수도 있지만, 자신이 사용하는 에디터를 사용해 작성하는 것도 가능합니다. 이 글에서는 에디터로 커밋 메시지를 작성하는 방법을 소개합니다.
전체 기사는 이 링크에서 읽을 수 있습니다.

Git 커밋 메시지를 에디터에서 작성하는 방법

댓글