Skip to content

Commit

Permalink
docs: update README and add AI doc
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelCurrin committed Oct 28, 2023
1 parent eb35819 commit a748275
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
**[Getting started](#getting-started) | [Features](#features) | [Screenshots](#sample-usage) | [Documentation](#documentation)**
-->

</div>


Expand Down Expand Up @@ -76,10 +76,12 @@ See more info on the [Features](/docs/features.md) 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.
Other 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.

This extension takes _zero_ parameters. Just click a button.

With the explosion of AI tools, you can find alternatives to this extension which use AI - see [AI tools](/docs/other/ai-tools.md)


## Sample usage

Expand Down
9 changes: 9 additions & 0 deletions docs/other/ai-tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# AI tools

Search for "gpt commit" in the extensions marketplace and you'll see plenty of extensions that use GPT to write your commit message.

e.g. [GPT Commit](https://marketplace.visualstudio.com/items?itemName=DmytroBaida.gpt-commit)

If done well, this could be even more flexible and natural than Auto Commit Msg which has no AI (but at least handles basic messages for a variety of cases based on the files that changed rather than the contents).

Though the downside for the AI tools they need an API key (pay, or only free limited time) and you are a limited by the processing and network speed. Also, I don't know if GPT is powerful enough to figure out the context of what you are doing and intend to write, as some of the reasoning for a change won't be covered by code itself but by real world events and requirements.

0 comments on commit a748275

Please sign in to comment.