Gooroo.dev

Gooroo.dev

Instant Code Reviews for Your Dev Teams

Getting Started with Gooroo.dev

Welcome to the Gooroo.dev GitHub App Help Page!

Thank you for using Gooroo.dev, your automated code review assistant. This help page will guide you through installing and using the Gooroo.dev GitHub App to ensure you get the most out of our automated code review services.

Table of Contents

  1. Getting Started
  2. Installation Guide
  3. Using Gooroo.dev
  4. Features
  5. Troubleshooting
  6. Frequently Asked Questions (FAQs)
  7. Support

Getting Started

Gooroo.dev makes it easy to automate code reviews for your GitHub repositories. Follow the steps below to install and start using the app.

Installation Guide

  1. Go to the GitHub Marketplace:

  2. Install the App:

    • Click the “Install” button on the Gooroo.dev page.
    • Select the GitHub account or organization where you want to install the app.
    • Choose the repositories you want Gooroo.dev to have access to. You can select all repositories or specific ones.

  3. Authorize Permissions:

    • Grant the necessary permissions for Gooroo.dev to access your repositories and perform code reviews.

  4. Complete the Installation:

    • Confirm the installation, and you’re all set!

Using Gooroo.dev

Automatic Pull Request Review

Once Gooroo.dev is installed, it will automatically review every new pull request created in the selected repositories. Here’s how it works:

  1. Create a Pull Request:

    • Create a pull request as you normally would in your GitHub repository.

  2. Automatic Review:

    • Gooroo.dev will automatically trigger a review of the pull request.
    • Within seconds, you will see a detailed review report added as a comment on the pull request.

Manual Pull Request Review

If you want Gooroo.dev to review an existing pull request manually, you can easily trigger a review by mentioning the app in a comment. Follow these steps:

  1. Go to the Pull Request:

    • Navigate to the pull request you want to review.

  2. Mention Gooroo.dev:

    • Add a comment with the mention: @gooroo-dev review.

  3. Receive Review Results:

    • Gooroo.dev will analyze the pull request and add a detailed review report as a comment.

Features

Gooroo.dev reviews your code for a variety of issues to help you maintain high code quality:

Mistakes Detection

  • Identifies common coding errors and potential bugs.

Security Risks

  • Scans for security vulnerabilities and provides recommendations.

Performance Issues

  • Analyzes code for potential performance bottlenecks.

Best Coding Practices

  • Ensures your code adheres to best practices and industry standards.

Troubleshooting

If you encounter any issues with Gooroo.dev, try the following steps:

  1. Check Permissions:

    • Ensure that Gooroo.dev has the necessary permissions to access your repositories.

  2. Review Installation:

    • Verify that Gooroo.dev is installed on the correct repositories.

  3. Contact Support:

    • If issues persist, please contact our support team for assistance.

Frequently Asked Questions (FAQs)

  1. How do I uninstall Gooroo.dev?

    • Go to your GitHub settings, navigate to “Installed GitHub Apps,” and remove Gooroo.dev.

  2. Can I customize the review criteria?

    • Currently, Gooroo.dev uses a standard set of rules for code reviews. Customization options will be available in future updates.

  3. Is there a limit to the number of reviews?

    • Currently, Gooroo.dev can review an unlimited number of pull requests in the repositories it has access to.

Support

If you need further assistance, please contact our support team: