{"id":14985667,"url":"https://github.com/andre-filho/commit-helper","last_synced_at":"2025-08-20T20:33:44.441Z","repository":{"id":33181886,"uuid":"145649081","full_name":"andre-filho/commit-helper","owner":"andre-filho","description":"A python program that helps you write commits following commit conventions","archived":false,"fork":false,"pushed_at":"2024-11-01T15:16:52.000Z","size":1736,"stargazers_count":19,"open_issues_count":10,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-25T09:07:29.631Z","etag":null,"topics":["cli","commit","commit-conventions","commit-helper","commit-message","commithelper","dev","git","git-commit","git-commit-format","git-commit-messages","github","hacktoberfest","hacktoberfest2020","helper","utility","yml"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/commit-helper/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andre-filho.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-08-22T03:08:22.000Z","updated_at":"2024-11-03T22:09:25.000Z","dependencies_parsed_at":"2024-05-01T16:45:09.460Z","dependency_job_id":"2a3cf460-c164-483c-a15d-d80d9c477e23","html_url":"https://github.com/andre-filho/commit-helper","commit_stats":{"total_commits":173,"total_committers":6,"mean_commits":"28.833333333333332","dds":0.1502890173410405,"last_synced_commit":"1e3e15ea41d8306393af0f515da2c8d7a50731e7"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andre-filho%2Fcommit-helper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andre-filho%2Fcommit-helper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andre-filho%2Fcommit-helper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andre-filho%2Fcommit-helper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andre-filho","download_url":"https://codeload.github.com/andre-filho/commit-helper/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230286885,"owners_count":18202771,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","commit","commit-conventions","commit-helper","commit-message","commithelper","dev","git","git-commit","git-commit-format","git-commit-messages","github","hacktoberfest","hacktoberfest2020","helper","utility","yml"],"created_at":"2024-09-24T14:11:27.373Z","updated_at":"2024-12-19T15:10:54.854Z","avatar_url":"https://github.com/andre-filho.png","language":"Python","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/andre-filho/commit-helper/master/assets/200-200.png\" style=\"align: center\"\u003e\n  \u003ch1 align=\"center\"\u003eCommit Helper\u003c/h3\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://travis-ci.org/andre-filho/commit-helper\"\u003e\n    \u003cimg src=\"https://travis-ci.org/andre-filho/commit-helper.svg?branch=master\" alt=\"Build Status\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://codeclimate.com/github/andre-filho/commit-helper/maintainability\"\u003e\n    \u003cimg src=\"https://api.codeclimate.com/v1/badges/0ef7545d395120222d77/maintainability\" alt=\"Maintainability\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://codebeat.co/projects/github-com-andre-filho-commit-helper-master\"\u003e\u003cimg alt=\"codebeat badge\" src=\"https://codebeat.co/badges/7621c6dc-7143-4efa-af3e-45508210d276\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.codacy.com/app/andre-filho/commit-helper?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=andre-filho/commit-helper\u0026amp;utm_campaign=Badge_Grade\"\u003e\n    \u003cimg src=\"https://api.codacy.com/project/badge/Grade/595af9a088cf44e19ec2679a8c2617f6\" alt=\"Codacy Badge\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://codeclimate.com/github/andre-filho/commit-helper/test_coverage\"\u003e\u003cimg src=\"https://api.codeclimate.com/v1/badges/0ef7545d395120222d77/test_coverage\" /\u003e\u003c/a\u003e\n  \u003ca class=\"badge-align\" href=\"https://www.codacy.com/app/andre-filho/commit-helper?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=andre-filho/commit-helper\u0026amp;utm_campaign=Badge_Coverage\"\u003e\n    \u003cimg src=\"https://api.codacy.com/project/badge/Coverage/595af9a088cf44e19ec2679a8c2617f6\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## What does it do?\nThe 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.\n\n## Why should I use this?\nKeeping a commit policy may sound like an easy thing to do, but in reality we both know that it isn't.\n\nSometimes we, the developers, go _full-loco_ while programming and make mistakes when commiting. That's fine, everyone makes mistakes. But, what if those mistakes could be avoided?\n\n## Screenshots\n\n### Initial commit\n\n\u003cimg src=\"https://raw.githubusercontent.com/andre-filho/commit-helper/master/assets/gifs/generate-file.gif\" style=\"min-width:200px;margin-left:auto;margin-right:auto;\"/\u003e\n\n### Normal commit\n\n\u003cimg src=\"https://raw.githubusercontent.com/andre-filho/commit-helper/master/assets/gifs/commit.gif\" style=\"min-width:200px;margin-left:auto;margin-right:auto;\"/\u003e\n\n### Commit without generating a configuration file\n\n\u003cimg src=\"https://raw.githubusercontent.com/andre-filho/commit-helper/master/assets/gifs/--no-file.gif\" style=\"min-width:200px;margin-left:auto;margin-right:auto;\"/\u003e\n\n### Co-authored commit\n\n\u003cimg src=\"https://raw.githubusercontent.com/andre-filho/commit-helper/master/assets/gifs/co-author.gif\" style=\"min-width:200px;margin-left:auto;margin-right:auto;\"/\u003e\n\n### Fast commit\n\n\u003cimg src=\"https://raw.githubusercontent.com/andre-filho/commit-helper/master/assets/gifs/single-line.gif\" style=\"min-width:200px;margin-left:auto;margin-right:auto;\"/\u003e\n\n### Debugging and commiting\n\n\u003cimg src=\"https://raw.githubusercontent.com/andre-filho/commit-helper/master/assets/gifs/--debug.gif\" style=\"min-width:200px;margin-left:auto;margin-right:auto;\"/\u003e\n\n### All-in-one commit\n\n\u003cimg src=\"https://raw.githubusercontent.com/andre-filho/commit-helper/master/assets/gifs/all.gif\" style=\"min-width:200px;margin-left:auto;margin-right:auto;\"/\u003e\n\n### Help\n\n\u003cimg src=\"https://raw.githubusercontent.com/andre-filho/commit-helper/master/assets/gifs/flag-h.gif\" style=\"min-width:200px;margin-left:auto;margin-right:auto;\"/\u003e\n\n### Getting help for writing in a convention\n\n\u003cimg src=\"https://raw.githubusercontent.com/andre-filho/commit-helper/master/assets/gifs/tag-help.gif\" style=\"min-width:200px;margin-left:auto;margin-right:auto;\"/\u003e\n\n## Installation\n\nIn order to install one of our older versions, check our [previous releases](PREVIOUS_VERSIONS). To install the latest (pip) version, just follow the commands below:\n\n```bash\n$ pip3 install commit-helper\n```\n\n## Updating your current version\n\nIf you already have one of our `pip` releases installed in your machine and want to update to the latest version, use the command:\n\n```bash\n$ pip3 install --upgrade commit-helper\n```\n\n## Usage and configuration\n\nThis program has a cli that you can take advantage of. Running `commit --help`\nwill show you the usage and options for your commit. All of them are optional\nfor the sake of not losing your precious time.\n\n```bash\n $ commit -h\nusage: commit [-h] [-t TAG] [-m MESSAGE] [-ct CONTEXT] [-ca CO_AUTHOR] [-nf]\n              [-c {angular,karma,tagged,symphony,message}] [-d]\n\nA commit formatter tool to help you follow commit conventions.\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -t TAG, --tag TAG     Pass your commit tag directly\n  -m MESSAGE, --message MESSAGE\n                        Pass your commit message directly\n  -ct CONTEXT, --context CONTEXT\n                        Pass your commit context directly\n  -ca CO_AUTHOR, --co-author CO_AUTHOR\n                        Make your friend an co-author to the commit\n  -nf, --no-file        Disables the creation of a commiter.yml or commit-helper.yml file\n  -c {angular,karma,tagged,symphony,message}, --convention {angular,karma,tagged,symphony,message}\n                        Selects a convention to be used for the commit.\n                        Required if there's no commiter.yml or commit-helper.yml file.\n  -d, --debug           Toggles debug option\n\n```\n\nSo, if you want to write a co-authored commit, you should use:\n\n```bash\n$ commit --co-author \"foo bar doritous \u003cfoobar@douritos.com\u003e\"\n```\n\nOr if you are using this for the first time in your project:\n\n```bash\n$ commit --convention tagged\n```\n\nTo work even more smoothly, have in your working directory a file named **commiter.yml or commit-helper.yml**. In this file you must pass the commit convention that you want to use, following the example:\n\n```yaml\nconvention: angular   # tag(context): commit message\n\n# or\n\nconvention: karma   # tag(context): commit message\n\n# or\n\nconvention: tagged # TAG: commit message\n\n# or\n\nconvention: symphony  # [Tag] commit message\n\n# and if you're feeling adventurous\n\nconvention: none      # Commit message\n```\n\nIn 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:\n\n```yaml\nconvention: custom\n# considering a commit message like '{add} (stuff) ~\u003e in file foo.br'\ncommit_pattern: '{tag} (context) ~\u003e message'\n# tag, message and context are reserved words that will be replaced in your commit message\ncontext: true # this is a must have field! If your pattern doesn't have one, assign false to it\n```\n\nSupported conventions available:\n\n - angular\n - karma\n - tagged\n - symphony\n - atom\n - only message (no convention)\n - a custom one that you may create :)\n\n ## Troubleshooting\n If after you've installed commit-helper the `commit` or `commit-helper` commands are not usable at the command line, check if `$HOME/.local/bin` is on your PATH. If not, add it on your .bashrc file by running:\n ``` bash\n$ echo \"export PATH=$HOME/.local/bin:$PATH\" \u003e\u003e .bashrc\n ```\n\n## Project's maintainers\n| **Name** | **Username** |\n| :--------: | :-----: |\n| André de Sousa Costa Filho | @andre-filho |\n\n## Our collaborators\n| **Name** | **Username** |\n| :------: | :----------: |\n| Arthur José Benedito de Oliveira Assis | @arthur0496 |\n| Matheus Richard Torres Gomes de Melo | @MatheusRich |\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandre-filho%2Fcommit-helper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandre-filho%2Fcommit-helper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandre-filho%2Fcommit-helper/lists"}