GitBenchmark is a command-line tool designed to facilitate Git usage and ensure compliance with commit standards. It provides commands for managing scopes, commit types, and commits.
-
Prerequisites: Make sure you have Git installed. You can check your Git version by running the following command:
git --version
If Git is not installed, please install it before proceeding.
-
Install GitBenchmark:
- Download the binary from the releases page.
- Place the binary in a directory included in your system's PATH.
- You can now use the
gb
orgitbenchmark
command in your terminal.
Here are the main commands available:
gb init
: Initializes config files.gb build [scope]
: Build to specific scope.gb scope [add|remove|list|check] [scope]
: Configures scopes.gb type [add|remove|list] [type]
: Configures commit types.gb commit [type]
: Performs a commit.
We welcome contributions! Here's how you can contribute:
- Fork the GitBenchmark repository on GitHub.
- Create a branch for your contribution.
- Make your changes and test them.
- Submit a pull request to the main branch.
Feel free to reach out if you have any questions or suggestions!