Enhancing Documentation and Updating Configuration for PR Descriptions

[mrT23]

PR Type:

Documentation, Enhancement

---

PR Description:

This PR includes updates to the documentation and configuration settings for PR descriptions. The main changes are:

• Added a new configuration option to use bullet points in PR descriptions.
• Updated the documentation files (IMPROVE.md and REVIEW.md) to include a note on code suggestions quality.
• Updated the prompts configuration files to reflect the new changes.

---

PR Main Files Walkthrough:

files:

pr_agent/tools/pr_description.py: Added a new configuration option 'use_bullet_points' to the PR description settings.
docs/IMPROVE.md: Added a new section on code suggestions quality, providing guidance on how to use and interpret the suggestions.
docs/REVIEW.md: Added a new section on code suggestions quality, providing guidance on how to use and interpret the suggestions.
pr_agent/settings/configuration.toml: Added a new configuration option 'use_bullet_points' under the 'pr_description' section.
pr_agent/settings/pr_description_prompts.toml: Updated the PR Description prompt to include the use of bullet points based on the new configuration option.
pr_agent/settings/pr_reviewer_prompts.toml: Updated the prompts for code suggestions and feedback to reflect the new changes.

[mrT23]

/describe

[github-actions]

PR Analysis

• 🎯 Main theme: Update documentation and prompts
• 📝 PR summary: This PR updates the documentation and prompts in the IMPROVE.md, REVIEW.md and pr_reviewer_prompts.toml files. The updates include adding notes on code suggestions quality and modifying the prompts to provide more diverse and insightful suggestions.
• 📌 Type of PR: Documentation
• 🧪 Relevant tests added: No
• ⏱️ Estimated effort to review [1-5]: 1, because the changes are straightforward and mainly involve text modifications in the documentation and prompts.
• 🔒 Security concerns: No security concerns found

PR Feedback

• 💡 General suggestions: The changes made in the PR are clear and improve the documentation and prompts. However, it would be beneficial to provide more context or examples in the documentation to help users better understand how to use the 'extra instructions' field and what kind of results they can expect from the 'improve --extended' mode.

• 🤖 Code feedback:

  • relevant file: docs/IMPROVE.md
    suggestion: Consider adding an example of how to use the 'extra instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project. [medium]
    relevant line: - Recommended to use the 'extra instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project.

  • relevant file: docs/REVIEW.md
    suggestion: It would be helpful to provide an example or case study showing the difference in suggestions quality between the 'review' and 'improve --extended' mode. [medium]
    relevant line: [- Unlike the 'review', which does a lot of things, the 'improve --extended' feature is dedicated to suggestions, and usually gives better suggestions](https://github.com/Codium-ai/pr-agent/pull/390/files#diff-a4b80781c151b79bd3d7acfe9d62ba33f793740839dcf46a4c98d037ec7db24dR57)

How to use

To invoke the PR-Agent, add a comment using one of the following commands:
/review [-i]: Request a review of your Pull Request. For an incremental review, which only considers changes since the last review, include the '-i' option.
/describe: Modify the PR title and description based on the contents of the PR.
/improve [--extended]: Suggest improvements to the code in the PR. Extended mode employs several calls, and provides a more thorough feedback.
/ask <QUESTION>: Pose a question about the PR.
/update_changelog: Update the changelog based on the PR's contents.

To edit any configuration parameter from configuration.toml, add --config_path=new_value
For example: /review --pr_reviewer.extra_instructions="focus on the file: ..."
To list the possible configuration parameters, use the /config command.