Code Monkey home page Code Monkey logo

better-comment's Introduction

Better Comment

Better Comment is a Chrome extension that analyzes your comments as you write them on GitHub to make sure they're not offensive and won't hurt the recipient's feelings. It uses OpenAI's API to analyze your comments and suggest improved wording.

How to install

  1. clone this repository to your local computer.

    git clone https://github.com/paperspoon/better-comment.git
  2. In the Chrome browser, navigate to chrome://extensions/.

  3. Activate the "Developer Mode" toggle in the top right corner.

  4. Click the top left "Load unpacked" button, and select the directory of the repository you cloned.

How to use

  1. Once the extension is installed, you'll see a new icon in the Chrome Extension Icons area.

  2. on a GitHub page, type in the text area to make a comment and when the focus leaves the form (onBlur), the comment is analyzed and the improved wording is displayed.

Setup

  1. To use an OpenAI API key, obtain an API key from the address below. https://platform.openai.com/

  2. click the extension icon, enter the API key in the pop-up window, and click the Save button.

  3. You can change the prompt or modify other options as needed.

TODO

  • Provide the option to write prompts with code (Likely consume a lot of tokens?)

Contribute

To contribute to the project, fork this repository, commit your changes, and create a pull request. After the pull request is reviewed, your contribution may be added to the project.

License

This project is licensed under the MIT License.

better-comment's People

Watchers

 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.