Git Product home page Git Product logo

english-copilot's Introduction

English Copilot

English Copilot is a VS Code extension designed to assist software engineers in writing clear and fluent comments in English. It leverages LLMs to improve the readability and grammatical correctness of your code comments.

How to use

  1. Select a block of text containing the comment you want to improve.
  2. Open the Command Palette in VS Code (Ctrl+Shift+P or Cmd+Shift+P).
  3. Select the "English Copilot: Improve Selected Block" command.
  4. The extension will process the selected comment and replace it with the improved version.

Requirements

To use English Copilot, you need to have an OpenAI API key. Sign up for an API key at OpenAI and configure it in the extension settings.

Extension Settings

English Copilot contributes the following settings:

  • english-copilot.openAiApiKey: Set your OpenAI API key here to enable the extension's functionality.
  • english-copilot.openAiModelName: Specify the name of the language model to use. Default is set to 'gpt-4'.

Release Notes

0.1.0

  • Initial release of English Copilot
  • Basic comment translation and grammatical error correction functionality

License

This extension is licensed under the Apache License 2.0. See the LICENSE file for more information.

Enjoy using English Copilot to enhance your code comments!

english-copilot's People

Contributors

minty99 avatar

Stargazers

Chansu Park avatar

Watchers

 avatar  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.