Developers are encouraged to submit cohesive and self-contained commits, with clear and uniform commit messages. That's exactly what SmartCommit tries to do, by firstly taking over the job of git-status, git-diff, git-add, git-commit and git-push commands.
To live up to the name, SmartCommit will gradually provide more advanced features to make it a real smart assistant for developers. Suggestions and Issues are welcomed!
- Stage&Commit changes in groups
- Diff&Compare diff code side by side or line by line
- Suggest words for commit message
- Push to the remote
- Customizable template for commit message (developing)
Currently the app only support Windows x64, Linux and macOS version will be released when the :-)
- Windows
- Git
- Network access
- Download the latest release installer
SmartCommit-Setup-x.y.z.exefrom https://github.com/Symbolk/SmartCommit/releases/latest ; - Double click it to install on your machine;
Security software like 360 may report warnings, it is safe to ignore.
- Choose&Copy the path to install it;
After the installation, better not choose to directly run it, see the following Usage.
- Append the path to
PATHof your environment variable.
- Download the latest release portable package
SmartCommit-Portable-x.y.z.zipfrom https://github.com/Symbolk/SmartCommit/releases/latest ; - Unzip the zip package to a folder, copy the path of this folder, in which you can find the file
SmartCommit.exe; - Append the path to
PATHof your environment variable.
When you have some changes to commit:
- Open the terminal (CMD or Git-bash),
cdto the git repo directory; - Type the command
git scthen you are ready to go!
In case of error:
git: 'sc' is not a git command. See 'git --help'.This is because thePATHenvironment variable is not reloaded, please restart the terminal after 3 mins or so.
- Windows
- Git ^2.18.0
- Node.js ^v10.16.0
- Yarn ~v1.16.0
- Vue-cli ~v3.8.4
- Run the following command under the root directory of the cloned repo to install dependencies:
yarn install
- Compiles and hot-reloads for development:
yarn run electron:serve
- [OR] Build the executable for production:
yarn run electron:build
SmartCommit is powered by multiple nice open source projects.
| Module | Component | Version |
|---|---|---|
| Frontend | Vue | ^2.6.10 |
| Scaffold | vue-smooth-dnd | ^0.8.0 |
| UI | bootstrap-vue | ^2.0.0-rc.24 |
| Modal | sweet-modal-vue | ^2.0.0 |
| Icon | vue-awesome | ^3.5.4 |
| App Framework | Electron | ^5.0.0 |
| Git Function | git-js | ^1.118.0 |
| Diff View | vue-monaco | ^1.0.1 |
| Language Detector | language-detect | ^1.1.0 |
| Git Graph | gitgraph.js | ^1.3.0 |
Copyright (c) 2019-present, Symbolk