より良いコミットメッセージ

より良いコミットメッセージ
私のTLを通り抜けることは下記のつぶやきを見ました.私のプロジェクトの大部分の1人の軍隊として、私はいつも典型的な1つのライナー、init、update、readme、fix - 01などを行います.この記事では、より良いコミットメッセージのためにVSCODEであなたのテンプレートを起動するためにGitを構成する方法をあなたに教えます.

ベン・オーセンシュタイン
r 00 k

ほとんどのコミットメッセージは、理由の代わりに行われたことに焦点を当てているので役に立たない.これは正確に間違ったことに焦点を当てることです.コミットが含まれている変更を常に再構築することができますが、実行された理由を解凍することは不可能です.(糸)
午後17時33分

テンプレート
これは私が現在使用しているテンプレートです.Here'sそれを使っている私の例.最初に何を書くかを考えるが、いくつかのコミット後にハングアップします.

# Commit Title (50 chars)

# Why? Issue, enhancement, etc.

# How does it address the why?

# Tickets, Links, etc...

ホームディレクトリにテンプレートを保存する
私はテンプレート.git_commit_msg.txtを命名しました、しかし、あなたはあなたが望むものは何でもそれを命名することができます.環境のホームパスを持っていない場合は、絶対パスを行います.

リナックス・マック${HOME}/.git_commit_msg.txt
Windows%HOME%/.git_commit_msg.txt
テンプレートをアクティブにする

リナックス・マック

git config --global commit.template ${HOME}/.git_commit_msg.txt

Windows

git config --global commit.template %HOME%/.git_commit_msg.txt

エディタの設定
core.editor docs
デフォルトのテキストエディタをチェックします

git config core.editor

私はgitコードでgitコードを設定しました

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

code needs to be on path, if you type code in terminal/prompt and the editor doesn't open, then open vscode and do CMD/CTRL+SHIFT+P, and type shell command, you should see install and uninstall options. Windows adds code by default during installation.

code can be replaced with your preferred text editor, vim, emacs, sublime, if you are having issues with your text editor, SO is your friend.

どうやって動くの?
コミットを行うと、テンプレートはvscodeで開き、テンプレート行のコメントを外し、新しいものを追加できます.メッセージを保存し、ファイルを閉じます.その時点であなたのコミットが完了します.何かを加えずにテンプレートを閉じると、コミットはキャンセルされます.あなたがPRを行うとき、その詳細なコミットメッセージはあなたのPRにあります.

git commit

You can still use -m argument for those pesky one liners.

何が好きですか.

1ライナーをお楽しみください.

コミットテンプレートを使用しますか?

あなたのチーム/会社は、テンプレートを実施しますか?

その他の方法は?

私はあなたが読んでくれたおかげで、このポストを楽しんでほしい!