Skip to content

Update README.md#6035

Merged
letzya merged 4 commits into
masterfrom
letzya-badges
Mar 26, 2024
Merged

Update README.md#6035
letzya merged 4 commits into
masterfrom
letzya-badges

Conversation

@letzya

@letzya letzya commented Feb 7, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

User description

  1. Improve badges (added links to badges)
  2. Based on feedback, add links to the docs for the tyk cloud and self-managed to make it easier for users to find the right doc before reading this page

Description

Related Issue

Motivation and Context

How This Has Been Tested

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Refactoring or add test (improvements in base code or adds test coverage to functionality)

Checklist

  • I ensured that the documentation is up to date
  • I explained why this PR updates go.mod in detail with reasoning why it's required
  • I would like a code coverage CI quality gate exception and have explained why

Type

documentation, enhancement

Description

  • Enhanced the README.md with clickable links for all badges, improving accessibility and user engagement.
  • Updated the color scheme of badges to maintain consistency and visual appeal.
  • Minor text corrections for clarity and grammar, specifically in the Docker usage section and the guide for writing tests.

Changes walkthrough

Relevant files
Enhancement
README.md
Enhance README with Badge Links and Minor Text Updates                 

README.md

  • Added links to badges for license, FOSSA status, GitHub latest
    release, GitHub release date, Docker pulls, GitHub workflow status, Go
    report card, GitHub commit activity, GitHub repo stars, GitHub repo
    forks, and Twitter follow.
  • Updated the GitHub release and Docker pulls badges with new color and
    links.
  • Corrected grammar in the section about running Docker in detach mode.
  • Updated the link for writing tests to use "To write" instead of "In
    order to write".
    		• +13/-4   
    ✨ 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.

    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:

    [pr_description] 
extra_instructions="""
- The PR title should be in the format: '<PR type>: <title>'
- The title should be short and concise (up to 10 words)
- ...
"""

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

    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.

    @letzya letzya mentioned this pull request Feb 7, 2024
    Closed
    17 tasks
    @letzya
    letzya requested a review from yurisasuke February 7, 2024 21:15
    @github-actions

    github-actions Bot commented Feb 7, 2024

    Copy link
    Copy Markdown
    Contributor

    PR Description updated to latest commit (7c9ddfa)

    @github-actions

    github-actions Bot commented Feb 7, 2024

    Copy link
    Copy Markdown
    Contributor

    API Changes

    no api changes detected

    @github-actions

    github-actions Bot commented Feb 7, 2024

    Copy link
    Copy Markdown
    Contributor

    PR Analysis

    • 🎯 Main theme: Enhancing the README.md file
    • 📝 PR summary: This PR focuses on enhancing the README.md file by adding clickable links to the badges and updating the color scheme of the badges. It also includes minor text modifications for better readability.
    • 📌 Type of PR: Documentation
    • 🧪 Relevant tests added: No
    • ⏱️ Estimated effort to review [1-5]: 1, because the changes are straightforward and limited to the README.md file.
    • 🔒 Security concerns: No security concerns found

    PR Feedback

    💡 General suggestions: The changes made in this PR are good and improve the user experience by making the badges clickable. The color scheme update also enhances the visual appeal of the README.md file. The text modifications improve readability. Overall, the changes are well thought out and executed.

    🤖 Code feedback:
    relevant fileREADME.md
    suggestion      

    Consider adding alt text to the badges for better accessibility. This will help users who rely on screen readers. [important]

    relevant line![License: MPL 2.0

    ✨ 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 'general suggestions' 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

    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_ticket, and more.

    Auto-approve PRs

    By invoking:

    /review auto_approve

    The tool will automatically approve the PR, and add a comment with the approval.

    To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following:

    [pr_reviewer]
enable_auto_approval = true

    (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository)

    You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag:

    [pr_reviewer]
maximal_review_effort = 5
    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.

    @github-actions

    github-actions Bot commented Feb 7, 2024

    Copy link
    Copy Markdown
    Contributor

    PR Code Suggestions

    No suggestions found to improve this PR.

    ✨ Usage guide:

    Overview:
    The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. 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 improve tool (pr_code_suggestions section), use the following template:

    /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

    With a configuration file, use the following template:

    [pr_code_suggestions]
some_config1=...
some_config2=...
    Enabling\disabling automation

    When you first install the app, the default mode for the improve tool is:

    pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...]

    meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

    Utilizing extra instructions

    Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project.

    Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on.

    Examples for extra instructions:

    [pr_code_suggestions] # /improve #
extra_instructions="""
Emphasize the following aspects:
- 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.

    A note on code suggestions quality
    • While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
    • Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base.
    • Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool
    • With large PRs, best quality will be obtained by using 'improve --extended' mode.
    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 improve usage page for a more comprehensive guide on using this tool.

    @buger

    buger commented Feb 7, 2024 •
    edited
    Loading

    Copy link
    Copy Markdown
    Member

    API tests result - postgres15-sha256 env: success ✅
    Branch used: refs/pull/6035/merge
    Commit: 1701901
    Triggered by: pull_request (@Keithwachira)
    Execution page

    @buger

    buger commented Feb 7, 2024 •
    edited
    Loading

    Copy link
    Copy Markdown
    Member

    API tests result - mongo44-sha256 env: success ✅
    Branch used: refs/pull/6035/merge
    Commit: 1701901
    Triggered by: pull_request (@Keithwachira)
    Execution page

    @letzya letzya mentioned this pull request Feb 7, 2024
    Closed
    7 tasks
    letzya added 2 commits February 8, 2024 16:06
    @letzya
    Update README.md
    93616ad 
    Improve badges (added links to badges)
    @letzya
    Update README.md
    6a10d61
    @sonarqubecloud

    sonarqubecloud Bot commented Feb 8, 2024

    Copy link
    Copy Markdown

    Please retry analysis of this Pull-Request directly on SonarCloud

    @letzya
    letzya enabled auto-merge (squash) February 8, 2024 16:34
    @github-actions

    github-actions Bot commented Feb 8, 2024

    Copy link
    Copy Markdown
    Contributor

    💥 CI tests failed 🙈

    git-state

    all ok

    Please look at the run or in the Checks tab.

    @sonarqubecloud

    sonarqubecloud Bot commented Mar 26, 2024

    Copy link
    Copy Markdown

    Quality Gate Passed Quality Gate passed

    Issues
    0 New issues
    0 Accepted issues

    Measures
    0 Security Hotspots
    No data about Coverage
    0.0% Duplication on New Code

    See analysis details on SonarCloud

    @letzya
    letzya merged commit 7e15ab5 into master Mar 26, 2024
    @letzya
    letzya deleted the letzya-badges branch March 26, 2024 11:18
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    1 more reviewer
    @yurisasuke yurisasuke yurisasuke approved these changes
    Reviewers whose approvals may not affect merge requirements

    Assignees

    No one assigned

    Labels

    Documentation enhancement Review effort [1-5]: 1

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    3 participants

    @letzya @buger @yurisasuke