← Back to blog

Introduction to Codedog

1/10/2024

Introduction to Codedog

What Codedog want

Code review is commonly executed in software development process to ensure the functional correctness and code quality of the incoming code changes. However, many teams are facing challenges doing code review:

  1. Time pressure: Task schedule and deadline is explicit and real-time, while the harm of code quality is hidden and long-term. Therefore, under higher delivery pressure, team tends reduce the investment in code review.
  2. Experienced reviewer Code review is a skill that needs to be learned and practiced in tech stack and the business logic. Such engineers's time is expensive and scarce.

With the success of Github Copilot, we believe that LLM can also help us in the code review process.

What Codedog propose ?

Specifically, Codedog is currently exploring ability in two directions:

  1. AI-assisted code review: Codedog aims to make Human Code Reviewing more efficient by providing valuable information to help reviewers understand the pull request better and faster.
  2. AI-driven code review: There are some typical problems happend here and there. Codedog can figure out your daily problems and let the developer fixed it based on ai feedback before we have reviewer involved in the process.

How to use Codedog

Github App

Installation

Install our app Codedog Assistant in your Github project.

Get your first code review

Create a mergable and non-draft pull request in your repository to see the assistant comment on the PR.

Usage limitation

Github App has a 10 PR / month limitation. If you reach the limitation and want more, you can contact us in Discord for a higher limitation.

Use codedog with Gitlab

Currently we only support gitlab with webhook trigger. Setup a webhook with:

https://api.codedog.ai/gitlab_event?gitlab_base_url=your_gitlab_base_url

Add your Gitlab base url, like "https://git.private-repository.com" to the query string.

Then you also need add a parameter gitlab_token to the request header. Which must have authority to read data and comment merge request in this repository. Which is at least reporter.

Self Hosted

Codedog core langchain application is open sourced and avaiable on Github

You can deploy your own PR review service with it.

Check the examples