Code Monkey home page Code Monkey logo

auto-commit-msg's Introduction

Auto Commit Message ⚙️ 🧙‍♂️ ✉️

A VS Code extension to generate a smart commit message based on file changes

Node CI CodeQL License Contributions - welcome

Logo

VS Code extension marketplace version VS Code extension installs VS Code extension rating maintained - yes

Preview

Starting from an empty commit message, the extension created a recommended message and populated it inside the Git pane of VS Code:

sample screenshot of chore

Getting started

How to install and run the extension in VS Code.

docs - Getting started

Features

Just click the extension's one button in the Git pane.

This is what the extension can do:

  • Look at any staged changes files, otherwise falls back to all unstaged changes.
  • Generate a commit message, which you can use or edit.
  • It can describe a variety of changes - when a file is added, removed, moved, renamed, etc.
  • Can handle multiple files at once.
  • Based on paths and extensions, infers a Conventional Commit prefix type e.g. feat, chore, ci, build, build(deps), docs.

See more info on the Features page in the docs.

Comparison with other extensions

Other extensions usually require some manual input, such as selecting prefix type from a droplist or writing a commit message by hand.

This extension takes zero parameters. Just click a button.

Sample usage

Here are some screenshots of what messages the extension generates based on changed files.

If you created a new file and staged it:

feat

If you updated a build-related file:

build

If updated a file in docs/ or a README.md anywhere:

docs

If you renamed a file:

rename

Documentation

Guides for installing and using the pre-built extension and for developers to build from source code.

view - Documentation

Contributing

See the Contributing guide.

License

Released under MIT by @MichaelCurrin.

See the Credit doc for more info.

auto-commit-msg's People

Contributors

michaelcurrin avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.