-
Notifications
You must be signed in to change notification settings - Fork 536
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Enhancements in Patch Formatting and Code Suggestions Handling #630
Conversation
…viewerPrompt models in settings files
PR Description updated to latest commit (6565556) |
PR Analysis(review updated until commit 15c8fe9)
PR Feedback💡 General suggestions: The PR is generally well-structured and the changes are clear. However, it would be beneficial to add tests to ensure the new enhancements work as expected and do not introduce any regressions. Additionally, consider parallelizing the prediction process in 🤖 Code feedback:
✨ Usage guide:Overview:
With a configuration file, use the following template:
See the review usage page for a comprehensive guide on using this tool. |
PR Code Suggestions
✨ Usage guide:Overview:
With a configuration file, use the following template:
See the improve usage page for a more comprehensive guide on using this tool. |
/improve |
PR Code Suggestions
✨ Usage guide:Overview:
With a configuration file, use the following template:
See the improve usage page for a more comprehensive guide on using this tool. |
/review |
Persistent review updated to latest commit 15c8fe9 |
PR Code Suggestions
✨ Usage guide:Overview:
With a configuration file, use the following template:
See the improve usage page for a more comprehensive guide on using this tool. |
Preparing suggestions... |
1 similar comment
Preparing suggestions... |
PR Code Suggestions
✨ Usage guide:Overview:
With a configuration file, use the following template:
See the improve usage page for a more comprehensive guide on using this tool. |
Preparing suggestions... |
/analyze |
PR Analysis
✨ Usage guide:Using static code analysis capabilities, the
Language that are currently supported: Python, Java, C++, JavaScript, TypeScript. |
/analyze |
PR Analysis
✨ Usage guide:Using static code analysis capabilities, the
Language that are currently supported: Python, Java, C++, JavaScript, TypeScript. |
Generated docstring for 'convert_to_hunks_with_lines_numbers'
Component signature: def convert_to_hunks_with_lines_numbers(patch: str, file) -> str: Docstring: """
Convert a given patch string into a string with line numbers for each hunk, indicating the new and old content of
the file.
Args:
patch (str): The patch string to be converted.
file: An object containing the filename of the file being patched.
Returns:
str: A string with line numbers for each hunk, indicating the new and old content of the file.
Example Output:
## file: '{file.filename.strip()}'
__new hunk__
881 line1
882 line2
883 line3
887 + line4
888 + line5
889 line6
890 line7
...
__old hunk__
line1
line2
- line3
- line4
line5
line6
...
""" |
Generated tests for 'convert_to_hunks_with_lines_numbers'
Component signature: def convert_to_hunks_with_lines_numbers(patch: str, file) -> str:
✨ Usage guide:The
where 'component_name' is the name of a specific component in the PR. To get a list of the components that changed in the PR, use the Configuration options: See more information about the test tool in the docs. |
Generated code suggestions for 'convert_to_hunks_with_lines_numbers'
Component signature: def convert_to_hunks_with_lines_numbers(patch: str, file) -> str:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Your code is really good
Enhancements in Patch Formatting and Code Suggestions Handling
Type
Enhancement
Description
git_patch_processing.py
andpr_processing.py
.pr_processing.py
to try a single run with standard diff string, patch extension, and no deletions.pr_code_suggestions.py
.Changes walkthrough
git_patch_processing.py
Improved Patch Formatting
pr_agent/algo/git_patch_processing.py
Modified the patch formatting to include the filename in a more
explicit manner.
Improved the formatting of new and old hunk sections in the patch.
pr_processing.py
Patch Processing Enhancements
pr_agent/algo/pr_processing.py
Updated the formatting of the final patch.
Added a new condition to try a single run with standard diff string,
patch extension, and no deletions.
pr_code_suggestions.py
Code Suggestions Improvement
pr_agent/tools/pr_code_suggestions.py
Added conditions to handle empty data in the ranking of suggestions.
Comment added to indicate future parallelization of prediction
generation.
pr_add_docs.toml
Documentation Update
pr_agent/settings/pr_add_docs.toml
Updated the example PR Diff format to match the new formatting.
pr_code_suggestions_prompts.toml
Code Suggestions Prompts Update
pr_agent/settings/pr_code_suggestions_prompts.toml
Updated the example PR Diff format and added a new 'language' field to
the CodeSuggestion model.
pr_description_prompts.toml
PR Description Prompts Update
pr_agent/settings/pr_description_prompts.toml
Added a new 'language' field to the FileDescription model.
pr_reviewer_prompts.toml
PR Reviewer Prompts Update
pr_agent/settings/pr_reviewer_prompts.toml
Updated the example PR Diff format and added a new 'language' field to
the feedback schema.
✨ Usage guide:
Overview:
The
describe
tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.When commenting, to edit configurations related to the describe tool (
pr_description
section), use the following template:With a configuration file, use the following template:
Enabling\disabling automation
meaning the
describe
tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description.the tool will replace every marker of the form
pr_agent:marker_name
in the PR description with the relevant content, wheremarker_name
is one of the following:type
: the PR type.summary
: the PR summary.walkthrough
: the PR walkthrough.Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.
Custom labels
The default labels of the
describe
tool are quite generic: [Bug fix
,Tests
,Enhancement
,Documentation
,Other
].If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases.
Examples for custom labels:
Main topic:performance
- pr_agent:The main topic of this PR is performanceNew endpoint
- pr_agent:A new endpoint was added in this PRSQL query
- pr_agent:A new SQL query was added in this PRDockerfile changes
- pr_agent:The PR contains changes in the DockerfileThe list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
Note that Labels are not mutually exclusive, so you can add multiple label categories.
Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.
Inline File Walkthrough 💎
For enhanced user experience, the
describe
tool can add file summaries directly to the "Files changed" tab in the PR page.This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs).
To enable inline file summary, set
pr_description.inline_file_summary
in the configuration file, possible values are:'table'
: File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab.true
: A collapsable file comment with changes title and a changes summary for each file in the PR.false
(default): File changes walkthrough will be added only to the "Conversation" tab.Utilizing extra instructions
The
describe
tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project.Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description.
Examples for extra instructions:
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
More PR-Agent commands
See the describe usage page for a comprehensive guide on using this tool.