https://github.com/khulnasoft/pr-insight-tests
https://github.com/khulnasoft/pr-insight-tests
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/khulnasoft/pr-insight-tests
- Owner: khulnasoft
- License: apache-2.0
- Created: 2024-09-28T15:21:20.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-31T02:52:51.000Z (9 months ago)
- Last Synced: 2025-02-01T02:16:30.864Z (8 months ago)
- Language: Python
- Size: 7.75 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# PR-Insight
[](https://github.com/khulnasoft/pr-insight/blob/main/LICENSE)
[](https://chromewebstore.google.com/detail/pr-insight-chrome-extension/ephlnjeghhogofkifjloamocljapahnl)
[](https://khulnasoft.github.io/pr-insight/finetuning_benchmark/)
[](https://discord.gg/NfDj6xsR)
[](https://twitter.com/khulnasoft)
### [Documentation](https://khulnasoft.github.io/pr-insight/)
- See the [Installation Guide](https://khulnasoft.github.io/pr-insight/installation/) for instructions on installing PR-Insight on different platforms.
- See the [Usage Guide](https://khulnasoft.github.io/pr-insight/usage-guide/) for instructions on running PR-Insight tools via different interfaces, such as CLI, PR Comments, or by automatically triggering them when a new PR is opened.
- See the [Tools Guide](https://khulnasoft.github.io/pr-insight/tools/) for a detailed description of the different tools, and the available configurations for each tool.
## Table of Contents
- [Table of Contents](#table-of-contents)
- [News and Updates](#news-and-updates)
- [May 31, 2024](#may-31-2024)
- [May 23, 2024](#may-23-2024)
- [May 21, 2024](#may-21-2024)
- [Overview](#overview)
- [Example results](#example-results)
- [Try it now](#try-it-now)
- [PR-Insight Pro 💎](#pr-insight-pro-)
- [Why use PR-Insight?](#why-use-pr-insight)
- [Data privacy](#data-privacy)
- [Self-hosted PR-Insight](#self-hosted-pr-insight)
- [KhulnaSoft-hosted PR-Insight Pro 💎](#khulnasoft-hosted-pr-insight-pro-)
- [PR-Insight Chrome extension](#pr-insight-chrome-extension)
- [Links](#links)
## News and Updates
### May 31, 2024
Check out the new [**PR-Insight Code Fine-tuning Benchmark**](https://khulnasoft.github.io/pr-insight/finetuning_benchmark/)
### May 23, 2024
We released a new version of [PR-Insight Chrome extension](https://chromewebstore.google.com/detail/pr-insight-chrome-extension/ephlnjeghhogofkifjloamocljapahnl), with two new features:
- PR-Insight filters 🎨
- Code suggestions interinsights 🔗
See more [here](https://www.youtube.com/watch?v=v9bJ1frtPcg)
### May 21, 2024
Check out KhulnaSoft new project, [**Coverage-Ai**](https://github.com/KhulnaSoft/coverage-ai), that can automatically generate qualified tests to enhance existing test suites, aiming to increase code and behavior coverage efficiently.
## Overview
Supported commands per platform:
| | | GitHub | Gitlab | Bitbucket | Azure DevOps |
|-------|---------------------------------------------------------------------------------------------------------|:--------------------:|:--------------------:|:--------------------:|:--------------------:|
| TOOLS | Review | ✅ | ✅ | ✅ | ✅ |
| | ⮑ Incremental | ✅ | | | |
| | ⮑ [SOC2 Compliance](https://khulnasoft.github.io/pr-insight/tools/review/#soc2-ticket-compliance) 💎 | ✅ | ✅ | ✅ | ✅ |
| | Describe | ✅ | ✅ | ✅ | ✅ |
| | ⮑ [Inline File Summary](https://khulnasoft.github.io/pr-insight/tools/describe#inline-file-summary) 💎 | ✅ | | | |
| | Improve | ✅ | ✅ | ✅ | ✅ |
| | ⮑ Extended | ✅ | ✅ | ✅ | ✅ |
| | Ask | ✅ | ✅ | ✅ | ✅ |
| | ⮑ [Ask on code lines](https://khulnasoft.github.io/pr-insight/tools/ask#ask-lines) | ✅ | ✅ | | |
| | [Custom Prompt](https://khulnasoft.github.io/pr-insight/tools/custom_prompt/) 💎 | ✅ | ✅ | ✅ | ✅ |
| | [Test](https://khulnasoft.github.io/pr-insight/tools/test/) 💎 | ✅ | ✅ | | ✅ |
| | Reflect and Review | ✅ | ✅ | ✅ | ✅ |
| | Update CHANGELOG.md | ✅ | ✅ | ✅ | ✅ |
| | Find Similar Issue | ✅ | | | |
| | [Add PR Documentation](https://khulnasoft.github.io/pr-insight/tools/documentation/) 💎 | ✅ | ✅ | | ✅ |
| | [Custom Labels](https://khulnasoft.github.io/pr-insight/tools/custom_labels/) 💎 | ✅ | ✅ | | ✅ |
| | [Analyze](https://khulnasoft.github.io/pr-insight/tools/analyze/) 💎 | ✅ | ✅ | | ✅ |
| | [CI Feedback](https://khulnasoft.github.io/pr-insight/tools/ci_feedback/) 💎 | ✅ | | | |
| | [Similar Code](https://khulnasoft.github.io/pr-insight/tools/similar_code/) 💎 | ✅ | | | |
| | | | | | |
| USAGE | CLI | ✅ | ✅ | ✅ | ✅ |
| | App / webhook | ✅ | ✅ | ✅ | ✅ |
| | Tagging bot | ✅ | | | |
| | Insights | ✅ | | ✅ | |
| | | | | | |
| CORE | PR compression | ✅ | ✅ | ✅ | ✅ |
| | Repo language prioritization | ✅ | ✅ | ✅ | ✅ |
| | Adaptive and token-aware file patch fitting | ✅ | ✅ | ✅ | ✅ |
| | Multiple models support | ✅ | ✅ | ✅ | ✅ |
| | [Static code analysis](https://khulnasoft.github.io/pr-insight/core-abilities/#static-code-analysis) 💎 | ✅ | ✅ | ✅ | ✅ |
| | [Global and wiki configurations](https://khulnasoft.github.io/pr-insight/usage-guide/configuration_options/) 💎 | ✅ | ✅ | ✅ | ✅ |
| | [PR interactive insights](https://www.khulnasoft.com/images/pr_insight/pr-insights.mp4) 💎 | ✅ | | | |
- 💎 means this feature is available only in [PR-Insight Pro](https://www.khulnasoft.com/pricing/)
[//]: # (- Support for additional git providers is described in [here](./docs/Full_environments.md))
___
‣ **Auto Description ([`/describe`](https://khulnasoft.github.io/pr-insight/tools/describe/))**: Automatically generating PR description - title, type, summary, code walkthrough and labels.
\
‣ **Auto Review ([`/review`](https://khulnasoft.github.io/pr-insight/tools/review/))**: Adjustable feedback about the PR, possible issues, security concerns, review effort and more.
\
‣ **Code Suggestions ([`/improve`](https://khulnasoft.github.io/pr-insight/tools/improve/))**: Code suggestions for improving the PR.
\
‣ **Question Answering ([`/ask ...`](https://khulnasoft.github.io/pr-insight/tools/ask/))**: Answering free-text questions about the PR.
\
‣ **Update Changelog ([`/update_changelog`](https://khulnasoft.github.io/pr-insight/tools/update_changelog/))**: Automatically updating the CHANGELOG.md file with the PR changes.
\
‣ **Find Similar Issue ([`/similar_issue`](https://khulnasoft.github.io/pr-insight/tools/similar_issues/))**: Automatically retrieves and presents similar issues.
\
‣ **Add Documentation 💎 ([`/add_docs`](https://khulnasoft.github.io/pr-insight/tools/documentation/))**: Generates documentation to methods/functions/classes that changed in the PR.
\
‣ **Generate Custom Labels 💎 ([`/generate_labels`](https://khulnasoft.github.io/pr-insight/tools/custom_labels/))**: Generates custom labels for the PR, based on specific guidelines defined by the user.
\
‣ **Analyze 💎 ([`/analyze`](https://khulnasoft.github.io/pr-insight/tools/analyze/))**: Identify code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component.
\
‣ **Custom Prompt 💎 ([`/custom_prompt`](https://khulnasoft.github.io/pr-insight/tools/custom_prompt/))**: Automatically generates custom suggestions for improving the PR code, based on specific guidelines defined by the user.
\
‣ **Generate Tests 💎 ([`/test component_name`](https://khulnasoft.github.io/pr-insight/tools/test/))**: Generates unit tests for a selected component, based on the PR code changes.
\
‣ **CI Feedback 💎 ([`/checks ci_job`](https://khulnasoft.github.io/pr-insight/tools/ci_feedback/))**: Automatically generates feedback and analysis for a failed CI job.
\
‣ **Similar Code 💎 ([`/find_similar_component`](https://khulnasoft.github.io/pr-insight/tools/similar_code/))**: Retrieves the most similar code components from inside the organization's codebase, or from open-source code.
___
## Try it now
Try the GPT-4 powered PR-Insight instantly on _your public GitHub repository_. Just mention `@KhulnaSoft` and add the desired command in any PR comment. The agent will generate a response based on your command.
For example, add a comment to any pull request with the following text:
```
@KhulnaSoft /review
```
and the agent will respond with a review of your PR
To set up your own PR-Insight, see the [Installation](https://khulnasoft.github.io/pr-insight/installation/) section below.
Note that when you set your own PR-Insight or use KhulnaSoft hosted PR-Insight, there is no need to mention `@KhulnaSoft ...`. Instead, directly start with the command, e.g., `/ask ...`.
---
[//]: # (## Installation)
[//]: # (To use your own version of PR-Insight, you first need to acquire two tokens:)
[//]: # ()
[//]: # (1. An OpenAI key from [here](https://platform.openai.com/), with access to GPT-4.)
[//]: # (2. A GitHub personal access token (classic) with the repo scope.)
[//]: # ()
[//]: # (There are several ways to use PR-Insight:)
[//]: # ()
[//]: # (**Locally**)
[//]: # (- [Using pip package](https://khulnasoft.github.io/pr-insight/installation/locally/#using-pip-package))
[//]: # (- [Using Docker image](https://khulnasoft.github.io/pr-insight/installation/locally/#using-docker-image))
[//]: # (- [Run from source](https://khulnasoft.github.io/pr-insight/installation/locally/#run-from-source))
[//]: # ()
[//]: # (**GitHub specific methods**)
[//]: # (- [Run as a GitHub Insight](https://khulnasoft.github.io/pr-insight/installation/github/#run-as-a-github-insight))
[//]: # (- [Run as a GitHub App](https://khulnasoft.github.io/pr-insight/installation/github/#run-as-a-github-app))
[//]: # ()
[//]: # (**GitLab specific methods**)
[//]: # (- [Run a GitLab webhook server](https://khulnasoft.github.io/pr-insight/installation/gitlab/))
[//]: # ()
[//]: # (**BitBucket specific methods**)
[//]: # (- [Run as a Bitbucket Pipeline](https://khulnasoft.github.io/pr-insight/installation/bitbucket/))
## PR-Insight Pro 💎
[PR-Insight Pro](https://www.khulnasoft.com/pricing/) is a hosted version of PR-Insight, provided by KhulnaSoft. It is available for a monthly fee, and provides the following benefits:
1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the PR-Insight app to your GitHub\GitLab\BitBucket repo.
2. **Improved privacy** - No data will be stored or used to train models. PR-Insight Pro will employ zero data retention, and will use an OpenAI account with zero data retention.
3. **Improved support** - PR-Insight Pro users will receive priority support, and will be able to request new features and capabilities.
4. **Extra features** -In addition to the benefits listed above, PR-Insight Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results.
See [here](https://khulnasoft.github.io/pr-insight/#pr-insight-pro) for a list of features available in PR-Insight Pro.
## Why use PR-Insight?
A reasonable question that can be asked is: `"Why use PR-Insight? What makes it stand out from existing tools?"`
Here are some advantages of PR-Insight:
- We emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single GPT-4 call, no more. We feel that this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably.
- Our [PR Compression strategy](https://khulnasoft.github.io/pr-insight/core-abilities/#pr-compression-strategy) is a core ability that enables to effectively tackle both short and long PRs.
- Our JSON prompting strategy enables to have **modular, customizable tools**. For example, the '/review' tool categories can be controlled via the [configuration](pr_insight/settings/configuration.toml) file. Adding additional categories is easy and accessible.
- We support **multiple git providers** (GitHub, Gitlab, Bitbucket), **multiple ways** to use the tool (CLI, GitHub Insight, GitHub App, Docker, ...), and **multiple models** (GPT-4, GPT-3.5, Anthropic, Cohere, Llama2).
## Data privacy
### Self-hosted PR-Insight
- If you host PR-Insight with your OpenAI API key, it is between you and OpenAI. You can read their API data privacy policy here:
https://openai.com/enterprise-privacy
### KhulnaSoft-hosted PR-Insight Pro 💎
- When using PR-Insight Pro 💎, hosted by KhulnaSoft, we will not store any of your data, nor will we use it for training. You will also benefit from an OpenAI account with zero data retention.
- For certain clients, KhulnaSoft-hosted PR-Insight Pro will use KhulnaSoft’s proprietary models — if this is the case, you will be notified.
- No passive collection of Code and Pull Requests’ data — PR-Insight will be active only when you invoke it, and it will then extract and analyze only data relevant to the executed command and queried pull request.
### PR-Insight Chrome extension
- The [PR-Insight Chrome extension](https://chromewebstore.google.com/detail/pr-insight-chrome-extension/ephlnjeghhogofkifjloamocljapahnl) serves solely to modify the visual appearance of a GitHub PR screen. It does not transmit any user's repo or pull request code. Code is only sent for processing when a user submits a GitHub comment that activates a PR-Insight tool, in accordance with the standard privacy policy of PR-Insight.
## Links
[](https://discord.gg/kG35uSHDBc)
- Discord community: https://discord.gg/NfDj6xsR
- KhulnaSoft site: https://khulnasoft.com
- Blog: https://www.khulnasoft.com/blog/
- Troubleshooting: https://www.khulnasoft.com/blog/technical-faq-and-troubleshooting/
- Support: support@khulnasoft.com