Package: commit-helper
Commit HelperWhat does it do?The commit-helper do exactly what it's name suggest: helps you create and maintain your commit policy by tailoring your commit message into a commit convention.Why should I use this?Keeping a commit policy may sound like an easy thing to do, but in reality we both know that it isn't.Sometimes we, the developers, gofull-locowhile programming and make mistakes when commiting. That's fine, everyone makes mistakes. But, what if those mistakes could be avoided?ScreenshotsInitial commitNormal commitCommit without generating a configuration fileCo-authored commitFast commitDebugging and commitingAll-in-one commitHelpGetting help for writing in a conventionInstallationIn order to install one of our older versions, check ourprevious releases. To install the latest (pip) version, just follow the commands below:$pip3installcommit-helperUpdating your current versionIf you already have one of ourpipreleases installed in your machine and want to update to the latest version, use the command:$pip3install--upgradecommit-helperUsage and configurationThis program has a cli that you can take advantage of. Runningcommit --helpwill show you the usage and options for your commit. All of them are optional
for the sake of not losing your precious time.$commit-h
usage:commit[-h][-tTAG][-mMESSAGE][-ctCONTEXT][-caCO_AUTHOR][-nf][-c{angular,karma,tagged,symphony,message}][-d]Acommitformattertooltohelpyoufollowcommitconventions.

optionalarguments:-h,--helpshowthishelpmessageandexit-tTAG,--tagTAGPassyourcommittagdirectly-mMESSAGE,--messageMESSAGEPassyourcommitmessagedirectly-ctCONTEXT,--contextCONTEXTPassyourcommitcontextdirectly-caCO_AUTHOR,--co-authorCO_AUTHORMakeyourfriendanco-authortothecommit-nf,--no-fileDisablesthecreationofacommiter.ymlorcommit-helper.ymlfile-c{angular,karma,tagged,symphony,message},--convention{angular,karma,tagged,symphony,message}Selectsaconventiontobeusedforthecommit.Requiredifthere'snocommiter.ymlorcommit-helper.ymlfile.-d,--debugTogglesdebugoptionSo, if you want to write a co-authored commit, you should use:$commit--co-author"foo bar doritous <foobar@douritos.com>"Or if you are using this for the first time in your project:$commit--conventiontaggedTo work even more smoothly, have in your working directory a file namedcommiter.yml or commit-helper.yml. In this file you must pass the commit convention that you want to use, following the example:convention:angular# tag(context): commit message# orconvention:karma# tag(context): commit message# orconvention:tagged# TAG: commit message# orconvention:symphony# [Tag] commit message# and if you're feeling adventurousconvention:none# Commit messageIn case that you or your organization does already have a commit convention that is not listed above, you can configure it in the commiter.yml or commit-helper.yml file as following:convention:custom# considering a commit message like '{add} (stuff) ~> in file foo.br'commit_pattern:'{tag}(context)~>message'# tag, message and context are reserved words that will be replaced in your commit messagecontext:true# this is a must have field! If your pattern doesn't have one, assign false to itSupported conventions available:angularkarmataggedsymphonyatomonly message (no convention)a custom one that you may create :)TroubleshootingIf after you've installed commit-helper thecommitorcommit-helpercommands are not usable at the command line, check if$HOME/.local/binis on your PATH. If not, add it on your .bashrc file by running:$echo"export PATH=$HOME/.local/bin:$PATH">>.bashrcProject's maintainersNameUsernameAndré de Sousa Costa Filho@andre-filhoOur collaboratorsNameUsernameArthur José Benedito de Oliveira Assis@arthur0496Matheus Richard Torres Gomes de Melo@MatheusRich