This is a simple Chrome extension that uses the power of Generative AI to generate insightful reviews on a Github pull request page.
The extension uses OpenAI to generate review comments. The AI model is trained on a large dataset of code reviews and can generate insightful comments on a pull request.
You will need an API key from OpenAI to use this extension. Also a free alternative is to use Groq API which is also supported by the extension.
You will also need to have a GitHub API Key to use the extension, as it uses the GitHub API to fetch the pull request data. You can get a Github API Key for free here. The only permission you need on the token is repo.
As the extension is not available on Chrome store yet, please follow the installation, build and test steps of the CONTRIBUTING.md file to install the extension locally on your machine.
Most of the Chrome extensions that use the OpenAI API to generate review comments are paid or have a limit on the number of requests you can make. This extension is open-source and free to use. You can host your own instance of the extension and use it without any limitations. Also you can customize the prompts and responses as per your needs.
With the current power of AI, teams are able to push code more frequently and faster. This is a good thing, but it also means that the code review process can be a bottleneck. This is where AI can help, by providing a supportive layer of review comments that can either help developers to improve their code before a human review or help developers to get a second opinion when submitting their reviews.
This is not, by any means, meant to replace human reviews, it's about leveraging the power of AI to help developers to boost the process of reviewing a code.
Example of where the individual file review button is located and the AI spotting a typo error that could be easily missed by a reviewer's eyes:
Settings available when clicking on the extension:
React is a JavaScript library for building user interfaces. It is maintained by Facebook and a community of individual developers and companies.
Source: docs
Typescript is a superset of JavaScript that adds optional types to the language. It is maintained by Microsoft.
Source: docs
GPT is a state-of-the-art language model developed by OpenAI. It is the third iteration of the Generative Pre-trained Transformer (GPT) series of models.
Source: docs
IndexedDB is a low-level API for client-side storage of significant amounts of structured data, including files/blobs. This API uses indexes to enable high-performance searches of this data. While Web Storage is useful for storing smaller amounts of data, it is less useful for storing larger amounts of structured data.
Source: docs
As we want to store all the prompts and apis responses in the browser, we are using IndexDB rather than local storage or session storage
Dexie.js is a wrapper library for IndexedDB. It makes it easier to work with IndexedDB by providing a simple API to interact with the database.
Source: docs
Vite is a build tool that aims to provide a faster and leaner development experience for modern web projects.
Source: docs
Thank you for considering contributing to the project. Please read the CONTRIBUTING.md file for more information before you start contributing.