Skip to content

README.md

Latest commit

 

History

History
92 lines (53 loc) · 1.85 KB

README.md

File metadata and controls

92 lines (53 loc) · 1.85 KB

🌟 Dr. Git

A powerful Git App built with Probot designed to enhance your development workflow by leveraging OpenAI to analyze and review your Pull Requests.

🚀 Overview

Dr. Git analyzes your code changes through branches and pull requests, linting the modified files or the entire source code. It provides insights on:

  • 🐞 Bugs
  • 💡 Improvements
  • ⚙️ Linting Issues
  • 🔒 Security Vulnerabilities

Harness the power of AI to ensure your code is clean, efficient, and secure!

🛠️ Setup

To get started with Dr. Git, follow these steps:

1. Install Dependencies

Make sure you have Node.js installed, then run the following command:

bun i

2. Build the app

Build the app using:

bun run build

3. Run the app

Start the app using:

bun start

4. Development mode

For development, you can use the following command. This will build the app, run Probot, and start the server, providing a smooth development experience:

bun dev

🐳 Docker Setup

You can also run Dr. Git using Docker. Follow these instructions:

1. Build the Container

Ask for environment variables and put them inside the .env file, then run this command:

docker compose up --build -d

🤝 Contributing

We welcome contributions to Dr. Git! If you have suggestions for improvements or wish to report a bug, please open an issue. We value all forms of contributions.

For more details, check out our Contributing Guide.

📜 License

This repository is not licensed. You may not use, copy, modify, or distribute this code without explicit permission.

💬 Support

If you have questions or need help, please feel free to open an issue or reach out!

Thank you for developing Dr. Git!