github.com/soypat/gitaligned@v0.3.4-0.20221228122414-e435aab44fbc/README.md (about) 1 [![Go Report Card](https://goreportcard.com/badge/github.com/soypat/gitaligned)](https://goreportcard.com/report/github.com/soypat/gitaligned) 2 [![go.dev reference](https://pkg.go.dev/badge/github.com/soypat/gitaligned)](https://pkg.go.dev/github.com/soypat/gitaligned) 3 [![codecov](https://codecov.io/gh/soypat/gitaligned/branch/main/graph/badge.svg)](https://codecov.io/gh/soypat/gitaligned/branch/main) 4 5 6 # gitaligned 7 Find out where you fall on the Open-Source Character Alignment Chart 8 --- 9 10 Binaries available in [releases](https://github.com/soypat/gitaligned/releases). 11 12 If you prefer to install from source, run the following in your command line (requires Go) 13 ``` 14 go install github.com/soypat/gitaligned@latest 15 ``` 16 17 ## How to use (requires git) 18 Run `gitaligned -h` for help. 19 20 Running gitaligned in this repo: 21 ``` 22 gitaligned -u soypat 23 ``` 24 25 Output: 26 ``` 27 Author soypat is Neutral Good 28 Commits: 6 29 Accumulated:{-0.2 2} 30 ``` 31 32 33 34 ## Planned 35 36 Output: 37 ``` 38 Steve -- Chaotic Neutral (89.9% confidence) 39 82 commits 40 99 % Lean towards Chaotic 41 10 % Lean towards Good 42 ``` 43 44 ### How it works (sort of) 45 46 For now gitaligned does some basic natural language processing using [`prose`](https://github.com/jdkato/prose) and has some ad-hoc rules based on typical git commit message mannerisms. 47 48 ***Opinions*** of commit messages and their alignment 49 50 | Commit Message | Alignment | 51 |---|---| 52 | `Fixed bug` | Neutral Evil | 53 |`Correct edge case in http response where long frames would overflow` | Lawful Good | 54 | `Steve's parser was really bad. Optimize and now works with extended unicode` | Chaotic Good | 55 | `Jacobian not singular` | True Neutral | 56 | `f*cking BNF` | Chaotic Evil | 57 58 "Good" commit messages seek to inform the reader of what changed and why. 59 60 "Evil" commit messages hide away what changed. 61 62 63 ### Author alignments on this repo 64 65 | Author | Alignment | 66 |--------|-----------| 67 | soypat | Chaotic Good | 68 | frenata | Lawful Neutral |