https://github.com/numonu/mitsco
Command line tool to manage commit messages
https://github.com/numonu/mitsco
command-line-tool git github management tool
Last synced: about 1 month ago
JSON representation
Command line tool to manage commit messages
- Host: GitHub
- URL: https://github.com/numonu/mitsco
- Owner: Numonu
- License: mit
- Created: 2023-11-07T14:57:06.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-08T14:29:49.000Z (over 2 years ago)
- Last Synced: 2025-11-27T09:16:02.420Z (7 months ago)
- Topics: command-line-tool, git, github, management, tool
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/mitsco
- Size: 43.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mitsco
**Command line tool to manage commit messages**
Mitsco is a command line tool that simplifies the creation of commits following specific and custom conventions, as well as allowing you to define the style of your commit messages. This streamlines the process of keeping track of changes to your project and encourages effective collaboration between team members.
## Features
- 🔥 **Custom Conventions** : Define your own conventions for commit messages according to the specific needs of your project.
- 🤩 **Configurable Message Styling** : Customize the style of your commit messages with ease, using placeholders such as **%type%** and **%message%**.
- ⏳ **Easy to Use** : Mitsco command line interface is intuitive and easy to use, streamlining the process of creating conventional commits.
## Installation
To start using Mitsco, install it as a global dependency using npm:
```bash
npm install -g mitsco
```
## Usage
To start using Mitsco, simply run the command mitsco in the root directory of your Git repository:
```bash
mitsco
```
Follow the on-screen instructions to create commits following your custom conventions and message style.
1. Select the type of commit you want to make:
2. Add a custom message to the commit:
3. Commit:
## Customization
You can configure the conventions and style of commit messages by creating a configuration file called **mitsco.config.json** in the root directory of your project.
### Style
Define the style of the commit messages. Use **%type%** for the commit type and **%message%** for your custom message.
```json
{
"style": "%type% : %message%"
}
```
### Types
The type convention defines the categories of commits to be used. By default, Mitsco uses the types provided by [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
```json
{
"types": [
{
"type": "chore",
"description": "used for maintenance tasks, refactoring, dependency updates, etc."
},
{
"type": "feat",
"description": "used to add a new feature."
},
{
"type": "fix",
"description": "used to fix a bug or issue."
},
{
"type": "refactor",
"description": "used for code changes that do not fix bugs or add new features."
},
{
"type": "style",
"description": "used for changes that do not affect code functionality (e.g., code formatting or style changes)."
},
{
"type": "docs",
"description": "used for documentation changes."
},
{
"type": "test",
"description": "used to add or improve tests."
}
]
}
```
## Contributions
If you want to contribute to Mitsco or report issues, visit the [contribution guide](/out/docs/contributing.md)
## License
This project is licensed under the MIT License. See the [LICENSE](LICENCE.txt) file for more details.