gpt-one-click-review README

Enjoy!

インストール手順

1. VS Codeのインストール
   まだVisual Studio Codeをインストールしていない場合、公式サイトからダウンロードし、インストールしてください。

2. VS Codeの拡張機能のインストール

   • Visual Studio Codeを開きます。
   • サイドバーのアイコンから「拡張機能」(四角いアイコン)をクリックします。
   • トップのメニューにある「...」(その他の操作)をクリックし、VSIXからのインストールを選択します。

3. .vsixファイルの選択

   • 事前に提供された.vsixファイルを探し、選択してください。
   • 選択が完了したら、自動的にインストールが開始されます。

4. OpenAI API Keyの設定

   • プラグインをインストールした後、Visual Studio Codeの設定画面に移動します。
   • このプラグインに特有の設定を検索します。
   • OpenAI API Keyの項目を見つけて、あなたのキーを入力します。
   • 設定を保存します。

5. 確認
   インストールが完了したら、VS Codeの「拡張機能」タブで新しくインストールされたプラグインが表示されることを確認してください。

6. 完了
   これでプラグインのインストールは完了です。VS Codeを再起動して、新しい機能を利用してください。

使い方

1. コードの選択
   Visual Studio Codeのエディタ上で、レビューしてほしい部分のコードを選択します。

2. レビュー機能の起動
   選択したコードの範囲で右クリックをします。表示されるコンテキストメニューの中からGPT-3 ReviewまたはGPT-4 Reviewをクリックします。

3. レビューの受領
   上記の操作を行うと、GPT-3またはGPT-4によるコードのレビューが開始されます。しばらくすると、レビューの結果が表示されますので、それに従ってコードの修正や改善を行うことができます。

Installation Instructions

1. Install VS Code
   If you haven't installed Visual Studio Code yet, download and install it from the official website.

2. Installing the VS Code Extension

   • Open Visual Studio Code.
   • Click on the 'Extensions' icon (shaped like a square) in the sidebar.
   • Click on the '...' (more actions) at the top of the menu and select Install from VSIX.

3. Select the .vsix file

   • Locate the provided .vsix file and select it.
   • Once selected, the installation will begin automatically.

4. Configure the OpenAI API Key

   • After installing the plugin, go to the settings of Visual Studio Code.
   • Search for the settings specific to this plugin.
   • Find the field for the OpenAI API Key and input your key.
   • Save the settings.

5. Verification
   After the installation completes, verify that the newly installed plugin appears in the 'Extensions' tab of VS Code.

6. Completion
   The plugin installation is now complete. Restart VS Code to start using the new features.

How to Use

1. Selecting the Code
   In the Visual Studio Code editor, highlight the section of code you want to have reviewed.

2. Initiating the Review
   Right-click on the highlighted code. From the context menu that appears, click on GPT-3 Review or GPT-4 Review.

3. Receiving the Review
   After performing the above steps, the review by GPT-3 or GPT-4 will begin. After a short while, you will receive feedback on the selected code. Use this feedback to make necessary corrections or improvements to your code.