search

Codium-ai / pr-agent

🚀CodiumAI PR-Agent: An AI-Powered 🤖 Tool for Automated Pull Request Analysis, Feedback, Suggestions and More! 💻🔍
Apache License 2.0
4.79k stars 412 forks source link

fix: update prompt key from `suggestion_content` to `suggestion_summary` in code suggestions #995

Closed mrT23 closed 1 week ago

mrT23 commented 1 week ago

PR Type

Bug fix

Description

Changes walkthrough 📝

Relevant files
Bug fix
pr_code_suggestions_reflect_prompts.toml
Update key from suggestion_content to suggestion_summary in example
YAML
pr_agent/settings/pr_code_suggestions_reflect_prompts.toml
  • Updated the key from suggestion_content to suggestion_summary in the
    example YAML output.
    		•  +2/-1     

    💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    codiumai-pr-agent-pro[bot] commented 1 week ago

    PR Reviewer Guide 🔍

    (Review updated until commit https://github.com/Codium-ai/pr-agent/commit/666fcb6264947fff7e99f7c429c4e5e242601e0e)

    ⏱️ Estimated effort to review [1-5] 1
    🏅 Score 95
    🧪 Relevant tests No
    🔒 Security concerns No
    🔀 Multiple PR themes No
    ⚡ Key issues to review None
    codiumai-pr-agent-pro[bot] commented 1 week ago

    PR Code Suggestions ✨

    No code suggestions found for PR.

    mrT23 commented 1 week ago

    /improve

    codiumai-pr-agent-pro[bot] commented 1 week ago

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Maintainability
    Adjust the indentation for consistency in the YAML structure ___ **Ensure that the indentation of the suggestion_summary and ... fields is consistent with
    the rest of the YAML structure to avoid potential parsing issues.** [pr_agent/settings/pr_code_suggestions_reflect_prompts.toml [62-68]](https://github.com/Codium-ai/pr-agent/pull/995/files#diff-aeee2207a4afb3ea3368c3e0140629bb3da8858b6d2315db5778661c9390d144R62-R68) ```diff suggestion_summary: | - Use a more descriptive variable name here + Use a more descriptive variable name here relevant_file: "src/file1.py" suggestion_score: 6 why: | - The variable name 't' is not descriptive enough + The variable name 't' is not descriptive enough ... ```
    Suggestion importance[1-10]: 7 Why: Proper indentation is crucial for the correct parsing of YAML files, and the suggestion correctly identifies and addresses a potential issue with the existing indentation.
    		7
    mrT23 commented 5 days ago

    /improve

    codiumai-pr-agent-pro[bot] commented 5 days ago

    PR Code Suggestions ✨

    No code suggestions found for PR.

    mrT23 commented 5 days ago

    /review

    codiumai-pr-agent-pro[bot] commented 5 days ago

    Persistent review updated to latest commit https://github.com/Codium-ai/pr-agent/commit/666fcb6264947fff7e99f7c429c4e5e242601e0e