You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+64-1Lines changed: 64 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,11 @@ $ sgc
35
35
36
36
You can even create a global config. Just go to your users home and create a `.sgcrc`. The global config will be triggered if no project configurations are present.
37
37
38
-
### Types
38
+
**Options:**
39
+
-[types](#types)
40
+
-[rules](#rules)
41
+
42
+
### types
39
43
40
44
> Types will define your git commits.
41
45
@@ -76,3 +80,62 @@ or the `package.json`:
76
80
}
77
81
}
78
82
```
83
+
84
+
### rules
85
+
86
+
Available rules:
87
+
88
+
-[max-char](#max-char)
89
+
-[min-char](#min-char)
90
+
-[end-with-dot](#end-with-dot)
91
+
92
+
#### max-char
93
+
94
+
**Type:**`number`
95
+
96
+
**Default:**`undefined`
97
+
98
+
If a number is set, it will not allow to commit messages **more than** the given number
99
+
100
+
Example:
101
+
```json
102
+
{
103
+
"rules": {
104
+
"max-char": 10
105
+
}
106
+
}
107
+
```
108
+
109
+
#### min-char
110
+
111
+
**Type:**`number`
112
+
113
+
**Default:**`undefined`
114
+
115
+
If a number is set, it will not allow to commit messages **less than** the given number
116
+
117
+
Example:
118
+
```json
119
+
{
120
+
"rules": {
121
+
"min-char": 10
122
+
}
123
+
}
124
+
```
125
+
126
+
#### end-with-dot
127
+
128
+
**Type:**`boolean`
129
+
130
+
**Default:**`true`
131
+
132
+
If it is set to false, it will not allow to commit messages with a dot at the
0 commit comments