Skip to content
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

Fix link formatting for relevant_line #584

Merged
merged 1 commit into from
Jan 10, 2024
Merged

Conversation

samanhappy
Copy link
Contributor

@samanhappy samanhappy commented Jan 9, 2024

Type

Bug fix


Description

  • Fixed a bug in the parse_code_suggestion function in pr_agent/algo/utils.py.
  • The hyperlink in the markdown text is now enclosed within single quotes to ensure proper formatting.

Changes walkthrough

Relevant files                                                                                                                                 
Bug fix
utils.py                                                                                                       
    pr_agent/algo/utils.py

    The PR contains a single change in the
    parse_code_suggestion function. The change is related to
    the formatting of the hyperlink in the markdown text.
    Previously, the link was added without quotes, which could
    potentially cause issues in certain scenarios. Now, the link
    is enclosed within single quotes to ensure proper
    formatting.

+1/-1

✨ 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:

/describe --pr_description.some_config1=... --pr_description.some_config2=...

With a configuration file, use the following template:

[pr_description]
some_config1=...
some_config2=...
Enabling\disabling automation
  • When you first install the app, the default mode for the describe tool is:
pr_commands = ["/describe --pr_description.add_original_user_description=true" 
                         "--pr_description.keep_original_user_title=true", ...]

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.

  • Markers are an alternative way to control the generated description, to give maximal control to the user. If you set:
pr_commands = ["/describe --pr_description.use_description_markers=true", ...]

the tool will replace every marker of the form pr_agent:marker_name in the PR description with the relevant content, where marker_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 performance
  • New endpoint - pr_agent:A new endpoint was added in this PR
  • SQL query - pr_agent:A new SQL query was added in this PR
  • Dockerfile changes - pr_agent:The PR contains changes in the Dockerfile
  • ...

The 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.

More PR-Agent commands

To invoke the PR-Agent, add a comment using one of the following commands:

  • /review: Request a review of your Pull Request.
  • /describe: Update the PR title and description based on the contents of the PR.
  • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
  • /ask <QUESTION>: Ask a question about the PR.
  • /update_changelog: Update the changelog based on the PR's contents.
  • /add_docs 💎: Generate docstring for new components introduced in the PR.
  • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
  • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

See the tools guide for more details.
To list the possible configuration parameters, add a /config comment.

See the describe usage page for a comprehensive guide on using this tool.

Copy link
Contributor

PR Description updated to latest commit (0f2a465)

Copy link
Contributor

codiumai-pr-agent-pro bot commented Jan 9, 2024

PR Analysis

(review updated until commit 0f2a465)

  • 🎯 Main theme: Fixing hyperlink formatting in markdown text
  • 📝 PR summary: This PR addresses a bug in the parse_code_suggestion function in pr_agent/algo/utils.py. The hyperlink in the markdown text is now enclosed within single quotes to ensure proper formatting.
  • 📌 Type of PR: Bug fix
  • 🧪 Relevant tests added: No
  • ⏱️ Estimated effort to review [1-5]: 1, because the PR contains a single line change which is straightforward and does not involve complex logic.
  • 🔒 Security concerns: No security concerns found

PR Feedback

💡 General suggestions: The PR is concise and addresses a specific issue. However, it would be beneficial to add a test case that covers this specific scenario to prevent future regressions.

🤖 Code feedback:
"
relevant filepr_agent/algo/utils.py
suggestion      

Consider using a markdown library to generate markdown text instead of manually formatting it. This could help prevent similar issues in the future and make the code more maintainable. [medium]

relevant linemarkdown_text += f"{relevant_line}


✨ Usage guide:

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...
Utilizing extra instructions

The review tool can be configured with extra instructions, which can be used 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. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.

Examples for extra instructions:

[pr_reviewer] # /review #
extra_instructions="""
In the code feedback section, emphasize the following:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""

Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation
  • When you first install PR-Agent app, the default mode for the review tool is:
pr_commands = ["/review", ...]

meaning the review tool will run automatically on every PR, with the default configuration.
Edit this field to enable/disable the tool, or to change the used configurations

About the 'Code feedback' section

The review tool provides several type of feedbacks, one of them is code suggestions.
If you are interested only in the code suggestions, it is recommended to use the improve feature instead, since it dedicated only to code suggestions, and usually gives better results.
Use the review tool if you want to get a more comprehensive feedback, which includes code suggestions as well.

Auto-labels

The review tool can auto-generate two specific types of labels for a PR:

  • a possible security issue label, that detects possible security issues (enable_review_labels_security flag)
  • a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)
Extra sub-tools

The review tool provides a collection of possible feedbacks about a PR.
It is recommended to review the possible options, and choose the ones relevant for your use case.
Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example:
require_score_review, require_soc2_review, enable_review_labels_effort, and more.

More PR-Agent commands

To invoke the PR-Agent, add a comment using one of the following commands:

  • /review: Request a review of your Pull Request.
  • /describe: Update the PR title and description based on the contents of the PR.
  • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
  • /ask <QUESTION>: Ask a question about the PR.
  • /update_changelog: Update the changelog based on the PR's contents.
  • /add_docs 💎: Generate docstring for new components introduced in the PR.
  • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
  • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

See the tools guide for more details.
To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

@mrT23
Copy link
Collaborator

mrT23 commented Jan 9, 2024

@samanhappy can you give example before and after the fix ? did the link wasn't working before ?

Copy link
Contributor

@barnett-yuxiang barnett-yuxiang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@samanhappy
Copy link
Contributor Author

@mrT23, when conducting tests on our self-managed GitLab instance

Before the fix:
Before Fix

After the fix:
After Fix

@mrT23
Copy link
Collaborator

mrT23 commented Jan 10, 2024

@samanhappy
you are correct, i see that too
image

Thanks for providing QA for GitLab. it's challenging to try and support multiple git providers (github, gitlab, bitbucket and more).

GitLab has similar UI as GitHub, but I guess they are not identical, so I will try in the future to validate more also on GitLab

@mrT23
Copy link
Collaborator

mrT23 commented Jan 10, 2024

Persistent review updated to latest commit 0f2a465

@mrT23 mrT23 merged commit fb4746f into Codium-ai:main Jan 10, 2024
@samanhappy samanhappy deleted the link branch January 10, 2024 10:28
yochail pushed a commit to yochail/pr-agent that referenced this pull request Feb 11, 2024
Fix link formatting for relevant_line
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants