Skip to content

Commit 33082dc

Browse files
committed
update commitTemplate.ts
1 parent 78f3bba commit 33082dc

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

src/git/commitTemplate.ts

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,23 @@
33
*
44
* TODO: Move to docs and link there.
55
*
6-
* Read the message from the a configured commit template file and use it as a prefix in the message.
6+
* Read the message from the a configured commit template file and use it as a
7+
* prefix in the message.
78
*
8-
* A commit template is built-in Git behavior to see a value for the start of each commit message. This is useful if you have a ticket number, project name, or similar to add at the start of each commit.
9+
* A commit template is built-in Git behavior to see a value for the start of
10+
* each commit message. This is useful if you have a ticket number, project
11+
* name, or similar to add at the start of each commit.
912
*
10-
* Note that VS Code and Git CLI both automatically read from this file when generating a commit. However, the value is hard to use. There is behavior in this extension to move the old message to the end and enter a commit type prefix and commit message before it, but there is no way to know from the content of the message for sure whether the old message is a commit template value or just a hand-typed message.
13+
* Note that VS Code and Git CLI both automatically read from this file when
14+
* generating a commit. However, the value is hard to use. There is behavior in
15+
* this extension to move the old message to the end and enter a commit type
16+
* prefix and commit message before it, but there is no way to know from the
17+
* content of the message for sure whether the old message is a commit template
18+
* value or just a hand-typed message.
1119
*
12-
* To avoid making an extra config value for the extension that one has to manage say in a Settings file or internal data, the approach is rather to use the existing commit template pattern in Git.
20+
* To avoid making an extra config value for the extension that one has to
21+
* manage say in a Settings file or internal data, the approach is rather to use
22+
* the existing commit template pattern in Git.
1323
*/
1424
import * as fs from "fs";
1525
import * as path from "path";

0 commit comments

Comments
 (0)