{"id":16551131,"url":"https://github.com/michaelcurrin/auto-commit-msg","last_synced_at":"2025-11-05T04:30:31.892Z","repository":{"id":37989974,"uuid":"270422708","full_name":"MichaelCurrin/auto-commit-msg","owner":"MichaelCurrin","description":"A VS Code extension to generate a smart commit message based on file changes","archived":false,"fork":false,"pushed_at":"2024-08-22T10:00:28.000Z","size":1790,"stargazers_count":128,"open_issues_count":56,"forks_count":13,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-12T19:36:38.460Z","etag":null,"topics":["auto","automation","commit","commit-message","commit-message-formatter","generate","git-commit","git-commit-messages","nodejs","typescript","vscode","vscode-extension"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=MichaelCurrin.auto-commit-msg","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MichaelCurrin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"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":"2020-06-07T20:22:38.000Z","updated_at":"2024-10-03T20:02:36.000Z","dependencies_parsed_at":"2024-08-05T13:08:24.491Z","dependency_job_id":"234c6baa-df6c-4c0f-a72a-795617ef5e0f","html_url":"https://github.com/MichaelCurrin/auto-commit-msg","commit_stats":null,"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Fauto-commit-msg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Fauto-commit-msg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Fauto-commit-msg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Fauto-commit-msg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MichaelCurrin","download_url":"https://codeload.github.com/MichaelCurrin/auto-commit-msg/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239449590,"owners_count":19640535,"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":["auto","automation","commit","commit-message","commit-message-formatter","generate","git-commit","git-commit-messages","nodejs","typescript","vscode","vscode-extension"],"created_at":"2024-10-11T19:36:27.115Z","updated_at":"2025-11-05T04:30:31.858Z","avatar_url":"https://github.com/MichaelCurrin.png","language":"TypeScript","readme":"# Auto Commit Message ⚙️ 🧙‍♂️ ✉️\n\u003e A VS Code extension to generate a smart commit message based on file changes\n\n\u003c!-- Badges mostly generated with https://michaelcurrin.github.io/badge-generator/#/ --\u003e\n\n[![Node CI](https://github.com/MichaelCurrin/auto-commit-msg/workflows/Node%20CI/badge.svg)](https://github.com/MichaelCurrin/auto-commit-msg/actions?query=workflow:\"Node+CI\")\n[![CodeQL](https://github.com/MichaelCurrin/auto-commit-msg/workflows/CodeQL/badge.svg)](https://github.com/MichaelCurrin/auto-commit-msg/actions?query=workflow%3ACodeQL)\n[![License](https://img.shields.io/badge/License-MIT-blue)](#license \"Go to License section\")\n[![Contributions - welcome](https://img.shields.io/badge/Contributions-welcome-blue)](/CONTRIBUTING.md \"View contributing doc\")\n\n\n\u003cdiv align=\"center\"\u003e\n\n\u003c!-- Must not be SVG. Also all image URLs must be full HTTPS URLs - absolute paths. --\u003e\n\u003ca href=\"https://marketplace.visualstudio.com/items?itemName=MichaelCurrin.auto-commit-msg\"\n    title=\"Go to Marketplace extension page\"\u003e\n\n\u003cimg src=\"https://github.com/MichaelCurrin/auto-commit-msg/raw/master/images/icon.png\"\n    alt=\"Logo\"\n    width=\"200\" /\u003e\n\n![VS Code extension marketplace version](https://img.shields.io/visual-studio-marketplace/v/MichaelCurrin.auto-commit-msg)\n![VS Code extension installs](https://img.shields.io/visual-studio-marketplace/i/MichaelCurrin.auto-commit-msg)\n![VS Code extension rating](https://img.shields.io/visual-studio-marketplace/r/MichaelCurrin.auto-commit-msg)\n![maintained - yes](https://img.shields.io/badge/maintained-yes-blue)\n\n\u003c/a\u003e\n\n\u003c!-- TODO: Fix in marketplace as it becomes plain text\n\n**[Getting started](#getting-started) | [Features](#features) | [Screenshots](#sample-usage) | [Documentation](#documentation)**\n\n--\u003e\n\n\u003c/div\u003e\n\n\n## Preview\n\nStarting from an empty commit message, the extension created a recommended message and populated it inside the Git pane of VS Code:\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/MichaelCurrin/auto-commit-msg/raw/master/docs/_media/sample-chore.png\"\n        alt=\"sample screenshot of chore\"\n        width=\"300\" /\u003e\n\u003c/div\u003e\n\n\u003c!-- TODO: Add GIF here --\u003e\n\n\n## Getting started\n\nHow to install and run the extension in VS Code.\n\n\u003cdiv align=\"center\"\u003e\n\n[![docs - Getting started](https://img.shields.io/badge/docs-getting_started-2ea44f?style=for-the-badge)](/docs/quickstart.md)\n\n\u003c/div\u003e\n\n\n## Features\n\nJust click the extension's one **button** in the Git pane.\n\nThis is what the extension can do:\n\n- Look at any **staged** changes files, otherwise falls back to all unstaged changes.\n- Generate a commit message, which you can use or edit.\n- It can describe a variety of changes - when a file is added, removed, moved, renamed, etc.\n- Can handle multiple files at once.\n- Based on paths and extensions, infers a **Conventional Commit** prefix type e.g. `feat`, `chore`, `ci`, `build`, `build(deps)`, `docs`.\n\nSee more info on the [Features](/docs/features.md) page in the docs.\n\n\n## Comparison with other extensions\n\nOther extensions usually require some manual input, such as selecting prefix type from a droplist or writing a commit message by hand along with other form parameters.\n\nThis extension takes _zero_ parameters. Just click a button.\n\n## Why not generate a commit message with AI?\n\nThis extension does not use AI. With the explosion of AI tools, you can find alternatives to this extension which use do AI - see notes here under [AI tools](/docs/other/ai-tools.md).\n\n\n## Sample usage\n\nHere are some screenshots of what messages the extension generates based on changed files.\n\nIf you created a new file and staged it:\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/MichaelCurrin/auto-commit-msg/raw/master/docs/_media/sample-feat.png\" alt=\"feat\" title=\"feat\" width=\"250\" /\u003e\n\u003c/div\u003e\n\nIf you updated a build-related file:\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/MichaelCurrin/auto-commit-msg/raw/master/docs/_media/sample-build.png\" alt=\"build\" title=\"build\" width=\"250\" /\u003e\n\u003c/div\u003e\n\nIf updated a file in `docs/` or a `README.md` anywhere:\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/MichaelCurrin/auto-commit-msg/raw/master/docs/_media/sample-docs.png\" alt=\"docs\" title=\"docs\" width=\"250\" /\u003e\n\u003c/div\u003e\n\nIf you renamed a file:\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/MichaelCurrin/auto-commit-msg/raw/master/docs/_media/sample-rename.png\" alt=\"rename\" title=\"rename\" width=\"250\" /\u003e\n\u003c/div\u003e\n\n\n## Documentation\n\nGuides for installing and using the pre-built extension and for developers to build from source code.\n\n\u003cdiv align=\"center\"\u003e\n\n[![view - Documentation](https://img.shields.io/badge/view-Documenation-blue?style=for-the-badge)](/docs/)\n\n\u003c/div\u003e\n\n\n## Contributing\n\nSee the [Contributing](/CONTRIBUTING.md) guide.\n\n\n## License\n\nReleased under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).\n\nSee the [Credit](/docs/other/credit.md) doc for more info.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelcurrin%2Fauto-commit-msg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichaelcurrin%2Fauto-commit-msg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelcurrin%2Fauto-commit-msg/lists"}