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
⚗️ Superfast CLI for the conventional commits commit format
9
+
Superfast CLI for the conventional commits commit format
10
10
11
-
## ❓ What is resin?
11
+
## What is resin?
12
12
13
13
resin is a CLI (command-line interface) tool that makes it easy to create commit messages that follow the [conventional commit format](https://www.conventionalcommits.org/). Here is a little demo:
14
14
@@ -17,12 +17,12 @@ resin is a CLI (command-line interface) tool that makes it easy to create commit
17
17
This demo will create the following commit message:
18
18
19
19
```txt
20
-
feat(config): add crates.io fields
20
+
feat[config]: add crates.io fields
21
21
```
22
22
23
-
## ✨ Features
23
+
## Features
24
24
25
-
### 🚩 Flags
25
+
### Flags
26
26
27
27
resin has three flags:
28
28
@@ -32,17 +32,17 @@ resin has three flags:
32
32
33
33
Super simple and easy to use!
34
34
35
-
### ⚙️ Configuration
35
+
### Configuration
36
36
37
-
#### 📖 Scopes
37
+
#### Scopes
38
38
39
39
You can configure resin to have your custom scopes. Below is an example config:
40
40
41
41
```toml
42
42
scopes = ['docker', 'github actions']
43
43
```
44
44
45
-
#### ✍️ Sign-off message
45
+
#### Sign-off message
46
46
47
47
You can also have a sign-off message that is based off the contents of your `~/.gitconfig` file:
48
48
@@ -56,28 +56,14 @@ This will create a message that will automatically be added to the bottom of you
56
56
Signed-off-by: Matt Gleich <git@mattglei.ch>
57
57
```
58
58
59
-
#### 📁 Location
59
+
#### Location
60
60
61
61
This file can be stored in `~/.config/resin/config.toml` or on a per-project basis by putting it at the root of the project with the same name. You can see a demo of this [for this project](resin.toml)
62
62
63
-
## 🚀 Install
63
+
## Install
64
64
65
65
You can install resin using [cargo](https://doc.rust-lang.org/cargo/index.html):
66
66
67
67
```bash
68
68
cargo install resin
69
69
```
70
-
71
-
## 🙌 Contributing
72
-
73
-
We would love to have you contribute! Please read the [contributing guide](CONTRIBUTING.md) before submitting a pull request. Thank you in advance!
0 commit comments