first

2023-03-06 22:54:12 +08:00
commit 4edb9bd7f7
14 changed files with 3146 additions and 0 deletions
@@ -0,0 +1,113 @@
+<div align="center">
+  <div>
+    <img src=".github/logo-grad.svg" alt="OpenCommit logo"/>
+    <h1 align="center">OpenCommit</h1>
+    <h4 align="center">Author <a href="https://github.com/di-sukharev">@di-sukharev</a> <a href="https://twitter.com/io_Y_oi"><img src="https://img.shields.io/twitter/follow/io_Y_oi?style=flat&label=io_Y_oi&logo=twitter&color=0bf&logoColor=fff" align="center"></a>
+    </h4>
+  </div>
+	<p>AI generates conventional commits with mind-blowing accuracy</p>
+	<a href="https://www.npmjs.com/package/opencommit"><img src="https://img.shields.io/npm/v/opencommit" alt="Current version"></a>
+</div>
+
+---
+
+## Examples
+
+Look into [the commits](https://github.com/di-sukharev/opencommit/commit) to see how OpenCommit works. Emoji and long commit description text is configurable.
+
+## Setup
+
+> The minimum supported version of Node.js is the latest v14. Check your Node.js version with `node --version`.
+
+1. Install opencommit globally to use in any repository:
+
+   ```sh
+   npm install -g opencommit
+   ```
+
+2. Get your API key from [OpenAI](https://platform.openai.com/account/api-keys)
+
+3. Set the key to opencommit config:
+
+   ```sh
+   opencommit config set OPENAI_API_KEY=<your token>
+   ```
+
+   Your token isn't sent to anyone, it's saved in `~/.opencommit` config file.
+
+## Usage
+
+You can call `opencommit` directly to generate a commit message for your staged changes:
+
+```sh
+git add <files...>
+opencommit
+```
+
+You can also use the `oc` shortcut:
+
+```sh
+git add <files...>
+oc
+```
+
+## Features
+
+### Preface commits with emoji 🤠
+
+[GitMoji](https://gitmoji.dev/) convention is used.
+
+To add emoji:
+
+```sh
+opencommit config set emoji=true
+```
+
+To remove emoji:
+
+```sh
+opencommit config set emoji=false
+```
+
+### Postface commits with descriptions of changes 🤠
+
+To add descriptions:
+
+```sh
+opencommit config set description=true
+```
+
+To remove description:
+
+```sh
+opencommit config set description=false
+```
+
+## Git hook
+
+You can set opencommit as Git [`prepare-commit-msg`](https://git-scm.com/docs/githooks#_prepare_commit_msg) hook. Hook integrates with you IDE Source Control and allows you edit the message before commit.
+
+To set the hook:
+
+```sh
+  opencommit hook set
+```
+
+To unset the hook:
+
+```sh
+  opencommit hook unset
+```
+
+To use the hook:
+
+```sh
+   git add <files...>
+   git commit
+```
+
+Or follow the process of your IDE Source Control feature, when it calls `git commit` command — OpenCommit will integrate into the flow.
+
+## Payments
+
+You pay for your own requests to OpenAI API. OpenCommit uses ChatGPT official model, that is ~10x times cheaper than GPT-3.