xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-16 02:30:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1485 from qodo-ai/tr/docs_best_practice

Browse Source 
Tr/docs best practice
This commit is contained in:
Tal
2025-01-26 16:40:09 +02:00
committed by GitHub
parent beffa8dfe4 63c98d30d9
commit 2277a31661
6 changed files with 115 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
pr_agent/settings/configuration.toml
View File

@ -307,7 +307,16 @@ number_of_results = 5
[lancedb]
uri = "./lancedb"
[best_practices]
content = ""
organization_name = ""
max_lines_allowed = 800
enable_global_best_practices = false
[auto_best_practices]
enable_auto_best_practices = true # public - general flag to disable all auto best practices usage
utilize_auto_best_practices = true # public - disable usage of auto best practices in the 'improve' tool
extra_instructions = "" # public - extra instructions to the auto best practices generation prompt
content = ""
max_patterns = 5 # max number of patterns to be detected

4
pr_agent/settings/pr_code_suggestions_prompts.toml
View File

@ -30,7 +30,7 @@ __old hunk__
@@ ... @@ def func2():
__new hunk__
unchanged code line4
+new code line5 removed
+new code line5 added
unchanged code line6
## File: 'src/file2.py'
@ -84,7 +84,7 @@ class CodeSuggestion(BaseModel):
relevant_file: str = Field(description="Full path of the relevant file")
language: str = Field(description="Programming language used by the relevant file")
suggestion_content: str = Field(description="An actionable suggestion to enhance, improve or fix the new code introduced in the PR. Don't present here actual code snippets, just the suggestion. Be short and concise")
existing_code: str = Field(description="A short code snippet from a '__new hunk__' section that the suggestion aims to enhance or fix. Include only complete code lines. Use ellipsis (...) for brevity if needed. This snippet should represent the specific PR code targeted for improvement.")
existing_code: str = Field(description="A short code snippet, from a '__new hunk__' section after the PR changes, that the suggestion aims to enhance or fix. Include only complete code lines. Use ellipsis (...) for brevity if needed. This snippet should represent the specific PR code targeted for improvement.")
improved_code: str = Field(description="A refined code snippet that replaces the 'existing_code' snippet after implementing the suggestion.")
one_sentence_summary: str = Field(description="A concise, single-sentence overview (up to 6 words) of the suggested improvement. Focus on the 'what'. Be general, and avoid method or variable names.")
{%- if not focus_only_on_problems %}