https://github.com/yeyom/better-commits
My CLI tool for creating commits using the conventional commits standard
https://github.com/yeyom/better-commits
bubbletea cli conventional-commits git golang lipgloss
Last synced: 2 months ago
JSON representation
My CLI tool for creating commits using the conventional commits standard
- Host: GitHub
- URL: https://github.com/yeyom/better-commits
- Owner: YeyoM
- Created: 2024-05-18T04:29:06.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-01T17:07:21.000Z (about 2 years ago)
- Last Synced: 2025-01-31T17:14:05.615Z (over 1 year ago)
- Topics: bubbletea, cli, conventional-commits, git, golang, lipgloss
- Language: Go
- Homepage:
- Size: 15.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Better Commits
This is my version of a CLI tool that is meant to help you write better commits, this tool helps you write your commits based on the convetional commits guideline.
### How it works?
There are a total of 6 steps to create a conventional commit
1. Select the type of change that you're committing
2. What is the scope of this change (user, admin, etc.) the user can select none
3. Select a gitmoji for the commit, or the user can select none
4. Write a short, imperative tense description of the change
5. Provide a longer description of the change
6. List any breaking changes or issues closed by this change
### How to use it?
Since this is a golang project, you can install it by cloning the repository and running the following command:
```bash
go build
```
This will create an executable file that you can run with the following command (Linux):
```bash
./better-commits
```
*Note, give the executable file the right permissions to run it*
After having the project compiled, you can run the following commands to add it to your path:
```bash
mv better-commits /usr/local/bin
```
Now you can run the command `better-commits` from anywhere in your terminal.
### How to contribute?
If you want to contribute to this project, you can fork the repository and create a pull request with your changes.
**Note:** This is my first golang project and is still in development, please be patient if there are some features that are not implemented yet, you can open an issue and together work on the feature or bug.
### License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.