diff --git a/Cargo.lock b/Cargo.lock index 982de01..4904532 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -101,7 +101,7 @@ dependencies = [ [[package]] name = "commit" -version = "0.3.0" +version = "0.3.1" dependencies = [ "anyhow", "assert_fs", diff --git a/Cargo.toml b/Cargo.toml index 6bf9d81..fb223d3 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "commit" -version = "0.3.0" +version = "0.3.1" edition = "2021" homepage = "https://github.com/alt-art/commit" repository = "https://github.com/alt-art/commit" @@ -39,8 +39,8 @@ assets = [ [package.metadata.generate-rpm] assets = [ # Binary - { source = "target/release/commit", dest = "/usr/bin/", mode = "111" }, + { source = "target/release/commit", dest = "/usr/bin/commit", mode = "111" }, ] [package.metadata.generate-rpm.requires] -git = "*" \ No newline at end of file +git = "*" diff --git a/README.md b/README.md index f143df5..4b0a912 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Commit +See [wiki page](https://github.com/alt-art/commit/wiki) for usage and configuration. + This command-line interface makes it possible to make patterned (conventional) commit messages to organize your repository. This project is a clone of [cz-cli](https://github.com/commitizen/cz-cli) with some minor changes. @@ -9,40 +11,15 @@ I made this project for my own use, because I don't want to mess with the origin ## Principal changes in this project - Don't need to make your project commitizen friendly -- Can be used with any project +- Can be used with any project and any language - Custom conventional commit message style can be used without any other packages -- Debian package is available -- Show original output of the git command - -## What I want to do - -- [x] Support for external config files -- [x] [Ability to override the questions with custom configuration](https://github.com/alt-art/commit/wiki#using-custom-configuration-file) -- [x] Ability to choose skip questions with custom configuration -- [x] [Make a wiki page for custom conventional commit message](https://github.com/alt-art/commit/wiki#using-custom-configuration-file) - -## Download - -[apt derivatives (deb)](https://github.com/alt-art/commit/releases/download/0.2.0/commit_0.2.0_amd64.deb) - -[dnf/yum derivatives (rpm)](https://github.com/alt-art/commit/releases/download/0.2.0/commit-0.2.0-1.x86_64.rpm) - -## How to make a debian package with cargo-deb for development - -Install cargo-deb: - -```bash -cargo install cargo-deb -``` - -Make a debian package: - -```bash -cargo deb -``` +- Plug and play just needs git installed -or just: +## Contributing -```bash -cargo deb --install # build and install the package -``` + - Fork this project + - Clone the fork + - Make your changes + - Commit your changes + - Push your changes + - Open a pull request