CODEWITHSUNDEEP
gitvim
joshuatvernon
joshuatvernon

Reputation: 1621

Add a hash/pound symbol as the first character in a git commit message in vim

GitHub (probably, wrongly) uses #'s when referring to GitHub issues. So I would like to add a commit message that refers to the issue on the first line.

e.g.

#12: New commit

- Did a thing
- Did another thing

Vim/git ignores lines starting with #'s though so I'm not sure how to escape it 🤷‍♂️

Upvotes: 12

Views: 2558

Answers (3)

IsraelDax
IsraelDax

Reputation: 19

Try:

git commit --amend -m "#Your_message_starting_with_a_hashtag"

Upvotes: 1

Yannoff
Yannoff

Reputation: 374

The simplest way to avoid git interpreting the issue number as a comment line, is to insert another character before, so the # is not the leading character of the line (a space will do the trick).

Here is an example:

#45

will be seen as a comment

 #45
Issue #45

will both be taken entirely as commit messages

Upvotes: 7

joshuatvernon
joshuatvernon

Reputation: 1621

Git allows you to update the comment char from the # symbol to any other. Then you can use the # symbol.

e.g.

git config core.commentChar '>'

or optionally set it globally

git config --global core.commentchar '>'

Upvotes: 15

Related Questions