From dcafa8f05f810d66522d5551c714e5a5fb40934f Mon Sep 17 00:00:00 2001
From: Hatter Jiang <jht5945@gmail.com>
Date: Sun, 12 Jul 2020 12:43:38 +0800
Subject: [PATCH] docs(commit-msg): add comment

---
 scripts/commit-msg.crs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/scripts/commit-msg.crs b/scripts/commit-msg.crs
index 4e01af2..4668145 100755
--- a/scripts/commit-msg.crs
+++ b/scripts/commit-msg.crs
@@ -4,6 +4,9 @@ use std::{ env, fs, process };
 use std::path::PathBuf;
 use std::process::Command;
 
+/// Git commit message format check util
+///
+/// Commit format MUST be <type>(<scope>): subject
 fn main() {
     let arg1 = env::args().nth(1).unwrap_or_else(|| {
         exit_with_error_message("Commit message is EMPTY!");