diff --git a/README.md b/README.md index 8a23014..bd30b24 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ -# cocommit +

+ cocommit +

- cocommit logo + cocommit logo

Github Latest Release @@ -11,7 +13,7 @@

-# How to run +## Install: *Insert blerb about go install if it works* Download the binary for your OS on the [release page](https://github.com/Slug-Boi/cocommit/releases) @@ -22,7 +24,7 @@ Once downloaded you need to create an alias for your shell guides found below: Once you've created an alias for the program you need to create an author file. You can run the program and it will prompt you to create an author file if one is not found in the default location. -Optionally you can set an env variable (author_file) in your shell. This should be the path pointing to your authors file +Optionally you can set an env variable (author_file) in your shell. This should be the path pointing to your author file For bash you just need to add this to your .bashrc file: ``` export author_file='path/to/your/aurhors' @@ -31,16 +33,15 @@ export author_file='path/to/your/aurhors' *Please note that the syntax line at the top of the authors file should not be deleted and that you must add at least one author to the file to run the program* -you can now run it using the alias shorthand you assigned to it ## Usage: -The CLI has two modes, the CLI commands and the TUI below are guides on how to use both +The CLI has two modes of operation, the CLI commands and the TUI below are guides on how to use both ### TUI To launch the TUI run the program with no args ``` $ cocommit ``` -From here you will be asked to write a commit message and then select authors from a list. This creates the same message as the CLI way of doing it but is a bit nicer to work with. The TUI has lots of keybinds that can be seen on the list view by pressing `?`. You can create authors, add temp authors or do all of the usual selections like negated selections or select all. Below is a small video showing a run through of the TUI. +From here you will be asked to write a commit message and then select authors from a list. The TUI has lots of keybinds that can be seen on the list view by pressing `?` (You can get to the list view by either creating a commit message or launching the TUI with the -a flag (stands for author_list)). You can create authors, add temp authors or do all of the usual selections like group selections, negated selections or select all. Below is a small gif/video showing a run through of the TUI. ^click me for video with timestamps^ @@ -70,19 +71,29 @@ $ cocommit users *prints list of users* ``` +### Commitizen Integration +**Note:** *This feature requires the commitizen package to be installed on your system.* +If you want to write the commit message using commitizen you can use the cz command: +``` +$ cocommit cz +``` +This will open the commitizen prompt and then you can select authors after as usual. By default it runs using the TUI mode of cocommit but you can use the -c flag to run it in CLI mode: +``` +$ cocommit cz -c +``` +This should allow for all the same utility as the normal CLI mode in terms of author selection + # Syntax for the author file The syntax for the author file can be found at the top of the template file included in the repo. It should look like this (opt) is optional syntax: ``` name_short|Name|Username|email (opt: |ex) (opt: ;;group1 or ;;group1|group2|group3...) ``` opt explained: -ex -> excludes the given author for all and negation commands +ex -> excludes the given author for all and negation selection commands group -> groups an author which can then be called as an argument to add all people from that group. An author can be a part of multiple groups # Why? -Writing co-authors onto commits can be pretty tedious so automating this process as a simple shell alias is a lot nicer - -# Workflows -This repo is sort of a test bed for working with Dagger CI but therefore also should support automated testing and building at some point -*See ci folder for the current dagger workflows* +Co-authoring commits is a feature that is supported by github and gitlab and other git hosting services but creating the commits can be a bit of a pain. Co-authoring is extremely useful as teams can be much more transparent in who worked on what and it can be a great way to give credit to people who have helped on projects. This will make git-blame a lot more useful as you can quickly see who to contact or talk to about a specific part of the code. I strongly believe that this feature is underutilized and i attribute it mostly to the fact that is combersome to use. This tool aims to fix and streamline that process. (It even allows for automation of the process with the CLI mode) +# Bugs and Feature Requests +If you find any bugs or have any feature requests please open an issue on the github page and I will look at it, please note this is very much a passion project of mine so things will take time. Feel free to also open a PR if you want to contribute to the project this will be greatly appreciated diff --git a/imgs/cocommit_logo.png b/imgs/cocommit_logo.png new file mode 100644 index 0000000..725730f Binary files /dev/null and b/imgs/cocommit_logo.png differ