pull assist

Pull Assist

Pull-Assist is a Chrome extension that uses ChatGPT to provide very basic code reviews on GitHub pull requests. It was mostly an excuse for me to play with GenAI but might be a useful tool for developers in their day-to-day work - whether that's helping someone review pull requests or just someone looking for quasi-peer review when working on their own.

Installation

1. Clone this repository:

   git clone https://github.com/simons/pull-assist.git
   cd pull-assist

2. Install dependencies:

   pnpm install

3. Build the extension:

   make

4. Load the extension into Chrome:

• Open Chrome and navigate to chrome://extensions

• Enable "Developer mode" in the top right corner

• Click "Load unpacked" and select the dist folder in the project directory

Configuration

Before using Pull-Assist, you need to configure it with your GitHub Personal Access Token (PAT) and OpenAI API key:

1. Click on the Pull-Assist extension icon in Chrome

2. Select "Options"

3. Enter your GitHub PAT and OpenAI API key

4. Click "Save"

To create a GitHub PAT, follow the instructions here.

To get an OpenAI API key, sign up at OpenAI and create a new API key.

Usage

1. Navigate to a GitHub pull request

2. Click the "Analyse PR" button that appears in the PR header

3. After a shortish wait, the suggestions should appear inline with the code changes (they're collapsed by default, click to expand)

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

Icon attribution: Assistance icons created by Freepik - Flaticon