Pull Mage

Pull Mage is your ultimate companion for managing PRs on GitHub. With Pull Mage, you can streamline your code review process, gain insights into your changes, and get answers to your questions — all in one place.

Public Page

Table of Contents

1. About The Project
2. Built With
3. Usage
   • Installation from GitHub Marketplace
   • How to Use
4. Notes
5. Running locally
   • Prerequisites
   • Installation
6. Contributing
7. Contact

About The Project

Pull Mage is a powerful tool designed to streamline the pull request (PR) process on GitHub. Whether you're a developer seeking feedback on your code changes or a reviewer providing insights and suggestions, Pull Mage simplifies and enhances the PR experience for everyone involved.

With Pull Mage, you can:

• Request comprehensive reviews of your PRs, receiving detailed feedback to improve code quality.
• Gain deep insights into the changes included in your PRs, with contextual explanations provided for each modification.
• Ask questions related to your PRs, getting prompt answers within the context of your changes.
• Leverage AI-driven assistance to analyze code changes, provide recommendations, and answer queries efficiently.

Pull Mage aims to promote collaboration, enhance code quality, and facilitate smoother workflows in GitHub repositories. Whether you're a solo developer or part of a team, Pull Mage is here to support you in achieving your goals and making your PR process more effective and efficient.

Built With

Usage

Installation from GitHub Public Page

1. Visit the Pull Mage GitHub Public page.
2. Click on the "Install" button to add Pull Mage to your GitHub repositories.

How to Use

1. After installing Pull Mage from the GitHub Marketplace, navigate to your GitHub repository.
2. Create a new pull request (PR) or open an existing one.
3. In the comments section of the PR, use the following commands to interact with Pull Mage:
   • /review: Request a review of your PR.
   • /explain: Get a detailed explanation of the changes in your PR.
   • /ask = question: Ask a question related to your PR.
4. Pull Mage will process your request and provide the requested feedback or information within the context of your PR.

That's it! With Pull Mage installed and configured in your GitHub repository, you can streamline your PR process and enhance collaboration with ease.

Notes

• Project Status: Pull Mage is a personal project and is currently running on free credits of OpenAI's API.
• Server Deployment: The server is deployed on a free tier. It may go down if it does not receive requests for a few minutes. You can ping https://pull-mage.siddhantkumarsingh.me/ to bring it back up.

Running locally

To get a local copy up and running follow these simple example steps.

Prerequisites

• npm or yarn

Installation

1. Clone the repo

   git clone https://github.com/Geralt-Of-Rivia-Witcher/Darkhold

2. Install NPM packages

   yarn

3. Ceate a .env file with following environment variables.

   APP_PORT = 'ENTER YOUR PORT HERE'
   GITHUB_APP_ID = 'ENTER YOUR GITHUB ID HERE'
   GITHUB_WEBHOOK_SECRET = 'ENTER YOUR GITHUB WEBHOOK SECRET HERE (not being used currently)'
   GITHUB_PRIVATE_KEY = 'ENTER YOUR GITHUB PRIVATE KEY HERE'
   OPENAI_API_KEY = 'ENTER YOUR OPENAI PRIVATE KEY HERE'

   you can get GITHUB_APP_ID and GITHUB_PRIVATE_KEY by creating a GitHub app from GitHub Developer settings: Guide

4. Start the server

   yarn start:dev

   The server will listen on APP_PORT specified in the .env file.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b branch_name)
3. Commit your Changes (git commit -m 'Added some AmazingFeature')
4. Push to the Branch (git push origin branch_name)
5. Open a Pull Request

Contact