docs: update prepareCommitMsg.ts

Author: MichaelCurrin

src/prepareCommitMsg.ts

@@ -35,10 +35,20 @@ export function _cleanJoin(first: string, second: string) {
   return `${first} ${second}`.trim();
 }
 
+/*
+ * Split message into prefix and description.
+ *
+ * Require a colon to exist to detect type prefix. i.e. 'ci' will be considered a description, but
+ * 'ci:' will be considered a prefix. This keeps the check simpler as we don't have to match against
+ * every type and we don't have to check if we are part of a word e.g. 'circus'.
+ */
 function _splitPrefixDesc(value: string) {
   return value.includes(":") ? value.split(":") : ["", value];
 }
 
+/**
+ * Split a prefix into a custom prefix and Conventional Commit type prefix.
+ */
 function _splitPrefixes(value: string) {
   return value.includes(" ")
     ? value.split(" ", 2)
@@ -47,10 +57,6 @@ function _splitPrefixes(value: string) {
 
 /**
  * Separate a message into a Conventional Commit type, if any, and the description.
- *
- * Require a colon to exist to detect type prefix. i.e. 'ci' will be considered a description, but
- * 'ci:' will be considered a prefix. This keeps the check simpler as we don't have to match against
- * every type and we don't have to check if we are part of a word e.g. 'circus'.
  */
 export function _splitMsg(msg: string) {
   const [prefix, description] = _splitPrefixDesc(msg)