From 46f2375165b050371f96c12f773a01df9b48b512 Mon Sep 17 00:00:00 2001
From: Boming Zhang <bomingzh@sjtu.edu.cn>
Date: Wed, 29 Jan 2025 07:55:45 -0500
Subject: [PATCH] docs(cmd/joj3): comments

---
 cmd/joj3/main.go | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/cmd/joj3/main.go b/cmd/joj3/main.go
index 24733e2..1398f6f 100644
--- a/cmd/joj3/main.go
+++ b/cmd/joj3/main.go
@@ -36,6 +36,8 @@ func mainImpl() (err error) {
 	var forceQuitStageName string
 	var teapotRunResult teapot.RunResult
 	var commitMsg string
+
+	// summarize
 	defer func() {
 		totalScore := 0
 		for _, stageResult := range stageResults {
@@ -64,6 +66,8 @@ func mainImpl() (err error) {
 		slog.Error("setup slog", "error", err)
 		return err
 	}
+
+	// parse flag & conf file
 	flag.Parse()
 	if *showVersion {
 		fmt.Println(Version)
@@ -96,6 +100,8 @@ func mainImpl() (err error) {
 		slog.Error("setup slog", "error", err)
 		return err
 	}
+
+	// log conf file info
 	sha256, err := conf.GetSHA256(confPath)
 	if err != nil {
 		slog.Error("get sha256", "error", err)
@@ -107,6 +113,8 @@ func mainImpl() (err error) {
 		slog.Error("conf check expire", "error", err)
 		return err
 	}
+
+	// run stages
 	groups := conf.MatchGroups(confObj, conventionalCommit)
 	stageResults, forceQuitStageName, err = stage.Run(
 		confObj, groups,
@@ -118,6 +126,8 @@ func mainImpl() (err error) {
 		slog.Error("stage write", "error", err)
 		return err
 	}
+
+	// run teapot
 	teapotRunResult, err = teapot.Run(confObj, groups)
 	if err != nil {
 		slog.Error("teapot run", "error", err)