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
> A CLI to keep semantic git commits. With emoji support 😄 👍
6
+
7
+
## Why?
8
+
9
+
Many projects got different git commit rules. It is hard to remember them all.
10
+
5
11
## Usage
6
12
7
13
```sh
@@ -20,3 +26,49 @@ or even shorter:
20
26
```sh
21
27
$ sgc
22
28
```
29
+
30
+
## Config
31
+
32
+
> Just create a `.sgcrc` in your project root or you can add everything in your `package.json` with the value `sgc`
33
+
34
+
### Types
35
+
36
+
> Types will define your git commits.
37
+
38
+
**Keys**
39
+
40
+
-`prefix` - This will be your commit convention and will be your start of your commit - e.g.: `Feat:`
41
+
-`description` (optional) - The description to explain what your prefix is about
42
+
-`emoji` (optional) - An emoji which will be appended at the beginning of the commit ([Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet/))
43
+
44
+
The `.sgcrc`:
45
+
46
+
```json
47
+
{
48
+
"types": [
49
+
{
50
+
"emoji": ":sparkles:",
51
+
"prefix": "Feat:",
52
+
"description": "Any description to describe the prefix"
53
+
}
54
+
]
55
+
}
56
+
```
57
+
58
+
The `package.json`:
59
+
60
+
```json
61
+
{
62
+
"name": "Your application name",
63
+
"version": "1.0.0",
64
+
"sgc": {
65
+
"types": [
66
+
{
67
+
"emoji": ":sparkles:",
68
+
"prefix": "Feat:",
69
+
"description": "Any description to describe the prefix"
0 commit comments