Organization Settings
In the Korbit console, you can customize how Korbit will interact with your pull requests and your team. Once you have completed the Getting Started Guide you can click here (opens in a new tab) to go to your organization settings.
Review Schedule
Korbit can be configured to comment on pull requests automatically and/or when a developer asks for input.
By default, Korbit will not comment on draft PRs.
You can always trigger a review from Korbit by commenting /korbit-review on your pull request.
This setting applies to all repositories in your organization.
Automatic PR Descriptions
As a Korbit admin, you can enable or disable Korbit’s automatic pull request descriptions feature. When enabled, Korbit will automatically append a description of the changes to your existing pull request description whenever a Korbit review is triggered.
Maximum Comments
Korbit will prioritize the most important issues it finds but you can set an upper limit of comments per review.
This is useful when Korbit analyzes larger PRs and sometimes finds a lot issues.
Issue Categories
As a Korbit admin, you can control which issue categories will be surfaced during a review and set a minimum severity for each category. Issues are classified as follows:
Functionality
Issues related to feature functionality, edge case handling, user interaction outcomes, and proper integration of functions, classes, and algorithms.
Security
Issues intended to protect your software against unauthorized access, data breaches, and other forms of exploitation.
Performance
Issues related to how efficiently (with respect to memory and processor time) your code responds to user actions, utilizes resources, and processes data.
Database Operations
Suggestions related to accessing, changing or adding to information in your database(s).
Asynchronous Processing
Suggestions to avoid potential race conditions, encourage performance optimization for asynchronous processes, etc.
Error Handling
Suggestions for detecting, responding to, and resolving exceptions or errors that occur while an application is running, plus how those errors are explained to users.
Naming
Clarity and consistency of the names of variables, functions, classes, and files your team uses in your code.
Logging
Suggestions to encourage writing clear, meaningful log messages, and ensuring that logs contain relevant information without exposing sensitive data.
Tests
Issues relating to unit tests, integration tests, system tests and acceptance tests.
Design Patterns
Any issues or best practices related to the consistency and clarity of the choice and application of creational, structural and behavioural design patterns in your code.
Systems and Environment
Issues related to the setup and configuration of your environments
Documentation
Clarity and breadth of inline comments, API documentation, README files, etc in your code.
Readability and Maintainability
Related to the structure of your code and suggestions on how to break it up or simplify it to facilitate re-use, clarity and easier maintenance.
Third-party Libraries
Issues related to the use of third party libraries, the way they are imported and kept up to date in your code.
Repositories
In order for Korbit to comment on your PRs, you must grant access to the Korbit application in GitHub or BitBucket.
In the Repositories section of the Korbit console, you can see which workspaces and repositories have been granted access.
If you want to add additional repositories or remove access for one or more repositories, click through to GitHub or BitBucket to make the change.
Manage Team
In this section, an Admin can invite other team members to the Korbit console. An Admin can also remove team members from the console.
Any team member with access to the repository can ask Korbit for a review. It is not necessary for the team member to have console access to use Korbit via GitHub or BitBucket.
Only team members who initiate a Korbit review in a billing period are considered as billable seats. You are not charged for Admins and other team members who do not make PRs.