docs(commit-msg): add comment

2020-07-12 12:43:38 +08:00
parent 55af07b4d4
commit dcafa8f05f
1 changed files with 3 additions and 0 deletions
--- 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!");