mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-07-04 04:40:38 +08:00
Focused PR update
This commit is contained in:
@ -186,7 +186,7 @@ Here is a quick overview of the different sub-tools of PR Reviewer:
|
|||||||
- PR description and title
|
- PR description and title
|
||||||
- PR type classification
|
- PR type classification
|
||||||
- Is the PR covered by relevant tests
|
- Is the PR covered by relevant tests
|
||||||
- Is the PR minimal and focused
|
- Is this a focused PR
|
||||||
- Are there security concerns
|
- Are there security concerns
|
||||||
- PR Feedback
|
- PR Feedback
|
||||||
- General PR suggestions
|
- General PR suggestions
|
||||||
@ -202,7 +202,7 @@ This is how a typical output of the PR Reviewer looks like:
|
|||||||
- 🔍 **Description and title:** Yes
|
- 🔍 **Description and title:** Yes
|
||||||
- 📌 **Type of PR:** Enhancement
|
- 📌 **Type of PR:** Enhancement
|
||||||
- 🧪 **Relevant tests added:** No
|
- 🧪 **Relevant tests added:** No
|
||||||
- ✨ **Minimal and focused:** Yes, the PR is focused on adding two new handlers for language extension and token counting.
|
- ✨ **Focused PR:** Yes, the PR is focused on adding two new handlers for language extension and token counting.
|
||||||
- 🔒 **Security concerns:** No, the PR does not introduce possible security concerns or issues.
|
- 🔒 **Security concerns:** No, the PR does not introduce possible security concerns or issues.
|
||||||
|
|
||||||
#### PR Feedback
|
#### PR Feedback
|
||||||
@ -245,7 +245,7 @@ The different tools and sub-tools used by CodiumAI pr-agent are easily configura
|
|||||||
You can enable/disable the different PR Reviewer sub-sections with the following flags:
|
You can enable/disable the different PR Reviewer sub-sections with the following flags:
|
||||||
|
|
||||||
```
|
```
|
||||||
require_minimal_and_focused_review=true
|
require_focused_review=true
|
||||||
require_tests_review=true
|
require_tests_review=true
|
||||||
require_security_review=true
|
require_security_review=true
|
||||||
```
|
```
|
||||||
|
@ -12,7 +12,7 @@ def convert_to_markdown(output_data: dict) -> str:
|
|||||||
"Type of PR": "📌",
|
"Type of PR": "📌",
|
||||||
"Relevant tests added": "🧪",
|
"Relevant tests added": "🧪",
|
||||||
"Unrelated changes": "⚠️",
|
"Unrelated changes": "⚠️",
|
||||||
"Minimal and focused": "✨",
|
"Focused PR": "✨",
|
||||||
"Security concerns": "🔒",
|
"Security concerns": "🔒",
|
||||||
"General PR suggestions": "💡",
|
"General PR suggestions": "💡",
|
||||||
"Code suggestions": "🤖"
|
"Code suggestions": "🤖"
|
||||||
|
@ -5,7 +5,7 @@ publish_review=true
|
|||||||
verbosity_level=0 # 0,1,2
|
verbosity_level=0 # 0,1,2
|
||||||
|
|
||||||
[pr_reviewer]
|
[pr_reviewer]
|
||||||
require_minimal_and_focused_review=true
|
require_focused_review=true
|
||||||
require_tests_review=true
|
require_tests_review=true
|
||||||
require_security_review=true
|
require_security_review=true
|
||||||
extended_code_suggestions=false
|
extended_code_suggestions=false
|
||||||
|
@ -30,10 +30,10 @@ You must use the following JSON schema to format your answer:
|
|||||||
"description": "yes\\no question: does this PR have relevant tests ?"
|
"description": "yes\\no question: does this PR have relevant tests ?"
|
||||||
},
|
},
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
{%- if require_minimal_and_focused %}
|
{%- if require_focused %}
|
||||||
"Minimal and focused": {
|
"Focused PR": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "is this PR as minimal and focused as possible, with all code changes centered around a single coherent theme, described in the PR description and title ?" Make sure to explain your answer"
|
"description": "Is this a focused PR, in the sense that it has a clear and coherent title and description, and all PR code diff changes are properly derived from the title and description? Explain your response."
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
@ -106,8 +106,8 @@ Example output:
|
|||||||
{%- if require_tests %}
|
{%- if require_tests %}
|
||||||
"Relevant tests added": "No",
|
"Relevant tests added": "No",
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
{%- if require_minimal_and_focused %}
|
{%- if require_focused %}
|
||||||
"Minimal and focused": "yes\\no, because ..."
|
"Focused PR": "yes\\no, because ..."
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
},
|
},
|
||||||
"PR Feedback":
|
"PR Feedback":
|
||||||
|
@ -31,7 +31,7 @@ class PRReviewer:
|
|||||||
"diff": "", # empty diff for initial calculation
|
"diff": "", # empty diff for initial calculation
|
||||||
"require_tests": settings.pr_reviewer.require_tests_review,
|
"require_tests": settings.pr_reviewer.require_tests_review,
|
||||||
"require_security": settings.pr_reviewer.require_security_review,
|
"require_security": settings.pr_reviewer.require_security_review,
|
||||||
"require_minimal_and_focused": settings.pr_reviewer.require_minimal_and_focused_review,
|
"require_focused": settings.pr_reviewer.require_focused_review,
|
||||||
'extended_code_suggestions': settings.pr_reviewer.extended_code_suggestions,
|
'extended_code_suggestions': settings.pr_reviewer.extended_code_suggestions,
|
||||||
'num_code_suggestions': settings.pr_reviewer.num_code_suggestions,
|
'num_code_suggestions': settings.pr_reviewer.num_code_suggestions,
|
||||||
}
|
}
|
||||||
|
@ -6,3 +6,4 @@ openai==0.27.8
|
|||||||
Jinja2==3.1.2
|
Jinja2==3.1.2
|
||||||
tiktoken==0.4.0
|
tiktoken==0.4.0
|
||||||
uvicorn==0.22.0
|
uvicorn==0.22.0
|
||||||
|
pytest==7.4.0
|
@ -1,6 +1,6 @@
|
|||||||
# Generated by CodiumAI
|
# Generated by CodiumAI
|
||||||
from pr_agent.algo.utils import convert_to_markdown
|
from pr_agent.algo.utils import convert_to_markdown
|
||||||
|
import pytest
|
||||||
"""
|
"""
|
||||||
Code Analysis
|
Code Analysis
|
||||||
|
|
||||||
@ -50,7 +50,7 @@ class TestConvertToMarkdown:
|
|||||||
'Type of PR': 'Test type',
|
'Type of PR': 'Test type',
|
||||||
'Relevant tests added': 'no',
|
'Relevant tests added': 'no',
|
||||||
'Unrelated changes': 'n/a', # won't be included in the output
|
'Unrelated changes': 'n/a', # won't be included in the output
|
||||||
'Minimal and focused': 'Yes',
|
'Focused PR': 'Yes',
|
||||||
'General PR suggestions': 'general suggestion...',
|
'General PR suggestions': 'general suggestion...',
|
||||||
'Code suggestions': [
|
'Code suggestions': [
|
||||||
{
|
{
|
||||||
@ -74,12 +74,11 @@ class TestConvertToMarkdown:
|
|||||||
- 🔍 **Description and title:** Test description
|
- 🔍 **Description and title:** Test description
|
||||||
- 📌 **Type of PR:** Test type
|
- 📌 **Type of PR:** Test type
|
||||||
- 🧪 **Relevant tests added:** no
|
- 🧪 **Relevant tests added:** no
|
||||||
- ✨ **Minimal and focused:** Yes
|
- ✨ **Focused PR:** Yes
|
||||||
- 💡 **General PR suggestions:** general suggestion...
|
- 💡 **General PR suggestions:** general suggestion...
|
||||||
|
|
||||||
- 🤖 **Code suggestions:**
|
- 🤖 **Code suggestions:**
|
||||||
|
|
||||||
- **suggestion 1:**
|
|
||||||
- **Code example:**
|
- **Code example:**
|
||||||
- **Before:**
|
- **Before:**
|
||||||
```
|
```
|
||||||
@ -90,7 +89,6 @@ class TestConvertToMarkdown:
|
|||||||
Code after
|
Code after
|
||||||
```
|
```
|
||||||
|
|
||||||
- **suggestion 2:**
|
|
||||||
- **Code example:**
|
- **Code example:**
|
||||||
- **Before:**
|
- **Before:**
|
||||||
```
|
```
|
||||||
@ -116,7 +114,7 @@ class TestConvertToMarkdown:
|
|||||||
'Type of PR': {},
|
'Type of PR': {},
|
||||||
'Relevant tests added': {},
|
'Relevant tests added': {},
|
||||||
'Unrelated changes': {},
|
'Unrelated changes': {},
|
||||||
'Minimal and focused': {},
|
'Focused PR': {},
|
||||||
'General PR suggestions': {},
|
'General PR suggestions': {},
|
||||||
'Code suggestions': {}
|
'Code suggestions': {}
|
||||||
}
|
}
|
||||||
|
@ -47,7 +47,7 @@ class TestParseCodeSuggestion:
|
|||||||
"Suggestion number": "one",
|
"Suggestion number": "one",
|
||||||
"Description": "This is a suggestion"
|
"Description": "This is a suggestion"
|
||||||
}
|
}
|
||||||
expected_output = "- **suggestion one:**\n - **Description:** This is a suggestion\n\n"
|
expected_output = " **Description:** This is a suggestion\n\n"
|
||||||
assert parse_code_suggestion(input_data) == expected_output
|
assert parse_code_suggestion(input_data) == expected_output
|
||||||
|
|
||||||
# Tests that function returns correct output when 'before' or 'after' key has a non-string value
|
# Tests that function returns correct output when 'before' or 'after' key has a non-string value
|
||||||
@ -70,7 +70,7 @@ class TestParseCodeSuggestion:
|
|||||||
'before': 'Before 1',
|
'before': 'Before 1',
|
||||||
'after': 'After 1'
|
'after': 'After 1'
|
||||||
}
|
}
|
||||||
expected_output = "- **suggestion 1:**\n - **suggestion:** Suggestion 1\n - **description:** Description 1\n - **before:** Before 1\n - **after:** After 1\n\n" # noqa: E501
|
expected_output = " **suggestion:** Suggestion 1\n **description:** Description 1\n **before:** Before 1\n **after:** After 1\n\n"
|
||||||
assert parse_code_suggestion(code_suggestions) == expected_output
|
assert parse_code_suggestion(code_suggestions) == expected_output
|
||||||
|
|
||||||
# Tests that function returns correct output when input dictionary has 'code example' key
|
# Tests that function returns correct output when input dictionary has 'code example' key
|
||||||
@ -84,5 +84,5 @@ class TestParseCodeSuggestion:
|
|||||||
'after': 'After 2'
|
'after': 'After 2'
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
expected_output = "- **suggestion 2:**\n - **suggestion:** Suggestion 2\n - **description:** Description 2\n - **code example:**\n - **before:**\n ```\n Before 2\n ```\n - **after:**\n ```\n After 2\n ```\n\n" # noqa: E501
|
expected_output = " **suggestion:** Suggestion 2\n **description:** Description 2\n - **code example:**\n - **before:**\n ```\n Before 2\n ```\n - **after:**\n ```\n After 2\n ```\n\n"
|
||||||
assert parse_code_suggestion(code_suggestions) == expected_output
|
assert parse_code_suggestion(code_suggestions) == expected_output
|
||||||
|
Reference in New Issue
Block a user