doc: add docs to each function exported

Author: ItsAnas

commiter/commiter.go

@@ -7,12 +7,12 @@ import (
 	"os/exec"
 )
 
-// ParseCommitMessage fekopkp
+// ParseCommitMessage add the message Type following the real user message
 func parseCommitMessage(commitType string, input string) string {
 	return fmt.Sprintf("%s: %s", commitType, input)
 }
 
-// CommitMessage should
+// CommitMessage launch command to commit the message
 func CommitMessage(commitType string, input string) bool {
 	formattedMessage := parseCommitMessage(commitType, input)
 	myArguments := []string{"commit", "-m", formattedMessage}

interact/prompt.go

@@ -10,7 +10,8 @@ import (
 	"github.com/manifoldco/promptui"
 )
 
-// AskForCommit wesh
+// AskForCommit ask if the user wants to commit
+// and return true if so
 func AskForCommit() bool {
 	prompt := promptui.Select{
 		Label: "Do you want to commit ? [Yes/No]",
@@ -31,7 +32,7 @@ func getDescriptions(config jsonMapping.CommitConfig) []string {
 	return res
 }
 
-// AskForCommit wesh
+// AskCommitType ask which kind of commit the user wants
 func AskCommitType(config jsonMapping.CommitConfig) string {
 	descriptions := getDescriptions(config)
 	prompt := promptui.Select{
@@ -46,7 +47,8 @@ func AskCommitType(config jsonMapping.CommitConfig) string {
 	return config.Rules[index].Prefix
 }
 
-// AskForCommit wesh
+// AskForCommit ask if the user wants to create a sample file
+// and return true if so
 func AskForCreate() bool {
 	prompt := promptui.Select{
 		Label: "No .commit.json found. Do you want to create a simple one ? [Yes/No]",
@@ -59,7 +61,7 @@ func AskForCreate() bool {
 	return result == "Yes"
 }
 
-// AskMessage is blabla
+// AskMessage ask the user which message he wants to commits and return it
 func AskMessage() string {
 
 	validate := func(input string) error {

jsonMapping/mapper.go

@@ -52,19 +52,20 @@ func DecodeJsonConfig(input string) CommitConfig {
 	return config
 }
 
+// CreateSample simple sample file for .commit.json
 func CreateSample() bool {
 	config := CommitConfig{
 		Name:        "My Config",
 		Description: "Hey this is my config for commit",
 		Rules: []PrefixRule{
-			PrefixRule{
+			{
 				Prefix:      "feat",
 				Description: "feat: Implement new feature"},
-			PrefixRule{
+			{
 				Prefix:      "doc",
 				Description: "doc: writing doc",
 			},
-			PrefixRule{
+			{
 				Prefix:      "fix",
 				Description: "fix: fix bug",
 			},